Skip to content

Improve the article's readability; streamline the language. #519

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

Merged
merged 4 commits into from
May 6, 2025

Conversation

mattmath
Copy link
Contributor

@mattmath mattmath commented May 4, 2025

style: improve readability and streamline language

Proposed changes

The article was originally difficult to read, with a high grade level (12). The writing was wordy and conversational, and contained long sentences covering too many topics.

The proposed changes make the writing more direct and "punchy" while breaking up long, complex sentences.

Closes #ISSUE 363

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • [n/a] If the change involves potentially sensitive changes1, I have assessed the possible impact
  • [n/a] If applicable, I have added tests that prove my fix is effective or that my feature works
  • [n/a] I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@mattmath mattmath requested a review from a team as a code owner May 4, 2025 22:54
Copy link

github-actions bot commented May 4, 2025

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

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) labels May 4, 2025
@mattmath
Copy link
Contributor Author

mattmath commented May 4, 2025

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

@mattmath
Copy link
Contributor Author

mattmath commented May 4, 2025

recheck

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! I have a couple of suggested changes. I'd love it if you want to talk about it while we're still at the conference.

@mjang mjang merged commit ded2cef into nginx:main May 6, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants