Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: NGINX reverse proxy -- reportedly difficult to read #299

Open
mjang opened this issue Mar 18, 2025 · 2 comments
Open

doc: NGINX reverse proxy -- reportedly difficult to read #299

mjang opened this issue Mar 18, 2025 · 2 comments
Assignees
@noxian-byte
Labels
community good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)

Comments

@mjang
Copy link
Contributor

mjang commented Mar 18, 2025

Describe the bug

Doc in question: https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/

Reported through Qualtrics survey

Confirmation

  • Measured readability with Flesch-Kincaid. Reading level: 10.34
  • Sentences longer than 28 words: 9

Expected behavior

Readable content, especially for users for whom English is a second language
@mjang mjang added good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) community labels Mar 18, 2025
@mjang
Copy link
Contributor Author

mjang commented Mar 18, 2025

Note: @travisamartin has WiP to ID more "difficult to read" content. Candidate: https://docs.nginx.com/nginx/admin-guide/security-controls/securing-http-traffic-upstream/

Per test using vale, grade level of that doc is 12.33

@noxian-byte
Copy link
Contributor

Hello @mjang

I'd like to give it a go.I will start working on it and submit a PR soon.

noxian-byte added a commit to noxian-byte/documentation that referenced this issue Mar 25, 2025
@noxian-byte
Improve readability of NGINX reverse proxy doc (nginx#299)
9e7aed1
@noxian-byte noxian-byte mentioned this issue Mar 25, 2025
Merged
mjang pushed a commit that referenced this issue Mar 26, 2025
@noxian-byte @JTorreG
@ADubhlaoich @y82
Improve readability of NGINX reverse proxy doc (#299) (#314)
ee7fbde 
* Improve readability of NGINX reverse proxy doc (#299)

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: Alan Dooley <github@adubhlaoi.ch>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: Alan Dooley <github@adubhlaoi.ch>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: Alan Dooley <github@adubhlaoi.ch>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: Alan Dooley <github@adubhlaoi.ch>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: Alan Dooley <github@adubhlaoi.ch>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: yar <y82@users.noreply.github.com>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: yar <y82@users.noreply.github.com>

* Update content/nginx/admin-guide/web-server/reverse-proxy.md

Co-authored-by: yar <y82@users.noreply.github.com>

* Updated documentation based on review suggestions

---------

Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: Alan Dooley <a.dooley@f5.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@noxian-byte noxian-byte

Labels
community good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mjang @noxian-byte