Skip to content

Conversation

ghost
Copy link

@ghost ghost commented Mar 25, 2025

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

@ghost ghost self-requested a review as a code owner March 25, 2025 03:15
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com) labels Mar 25, 2025
Copy link

github-actions bot commented Mar 25, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@ghost
Copy link
Author

ghost commented Mar 25, 2025

I have hereby read the F5 CLA and agree to its terms

Copy link
Member

@ADubhlaoich ADubhlaoich left a 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.

@mjang mjang assigned ghost Mar 25, 2025
@mjang mjang added the community Issues or pull requests started by community members label Mar 25, 2025
Copy link
Contributor

@y82 y82 left a 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!

@ghost
Copy link
Author

ghost commented Mar 25, 2025

Hi @y82

I have applied all of the changes.Please let me know if there is something else I should modify.

@JTorreG JTorreG requested a review from y82 March 26, 2025 12:45
@mjang
Copy link
Contributor

mjang commented Mar 26, 2025

I appreciate your work @noxian-byte!

  • Thank you for your contribution!
  • Congratulations on getting your first contribution accepted and merged

FYI, I'm leaving the issue open as I hope for additional improvements.

@mjang mjang merged commit ee7fbde into nginx:main Mar 26, 2025
6 checks passed
@ghost ghost deleted the improve-docs-nginx-reverse-proxy branch March 27, 2025 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Issues or pull requests started by community members documentation Improvements or additions to documentation product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants