-
Notifications
You must be signed in to change notification settings - Fork 101
Improve readability of NGINX reverse proxy doc (#299) #314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve readability of NGINX reverse proxy doc (#299) #314
Conversation
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
I have hereby read the F5 CLA and agree to its terms |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doc changes generally LGTM! Put in some edit suggestions.
@y82 is the ultimate authority for NGINX core documentation.
The formatting changes for the directives are better, but I think there's still room there for something extra.
Possibly making the directive name a pseudo-heading with bold and dropping the colon: there's not enough of them to warrant a table, but even just breaking up the paragraph makes it more readable.
Thanks for the contribution! Let us know if there was anything about the process you found unclear.
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @noxian-byte,
Thank you for your contribution. I've left some comments - once they're fixed we're good to go. Thanks again!
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: yar <y82@users.noreply.github.com>
Hi @y82 I have applied all of the changes.Please let me know if there is something else I should modify. |
I appreciate your work @noxian-byte!
FYI, I'm leaving the issue open as I hope for additional improvements. |
Problem: A user had reported that the content was hard to read through a Qualtrics survey.
Solution: The content was summarized and split into bullet points where possible in order to make it more digestible and easier to read for non-native English speakers.
This PR addresses Issue - reportedly difficult to read