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.

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

Revise for readability (#75) #176

Merged
merged 16 commits into from
Feb 18, 2025
Merged

Revise for readability (#75) #176

merged 16 commits into from
Feb 18, 2025

Conversation

11t97
Copy link
Contributor

@11t97 11t97 commented Feb 7, 2025

Proposed changes

Problem: Topic included several hard to read sentences.

Solution:

  1. Revised text for readability. Improved Grade Level from Grade 9 to Grade 7.
  • Used Hemingwayapp to identify revision candidate sentences.
  1. Compared to Style Guide and revised to increase conformity.
  2. Changes not made to:
  • images
  • relative links

Testing: Evaluated text changes with Hemingwayapp
Screen Shot 2025-02-07 at 12 52 18 PM

Please focus on (optional): Verify relative links, previews showed some are broken, though later build of reuse content may enable.

Fixes #75

Checklist

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

  • [X ] I have read the contributing guidelines
  • [X ] I have signed the F5 Contributor License Agreement (CLA) expect this to occur with this PR
  • [X ] I have ensured that documentation content adheres to the style guide
  • [X ] If the change involves potentially sensitive changes, I have assessed the possible impact
  • [X ] If applicable, I have added tests that prove my fix is effective or that my feature works
  • [X ] If applicable, I have checked that any relevant tests pass after adding my changes
  • [X ] I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • [ X] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

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.

11t97 added 2 commits February 7, 2025 14:35
Corrections to align with style guide recommendations for:
* click/select
* load balancing
* configure/ set up
* (radio) button
* page directions
Clean up a couple of missed clicks.
@11t97 11t97 requested a review from a team as a code owner February 7, 2025 21:06
Copy link

github-actions bot commented Feb 7, 2025

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

@11t97
Copy link
Contributor Author

11t97 commented Feb 7, 2025

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

@jputrino
Copy link
Contributor

jputrino commented Feb 7, 2025

Hi @11t97, thanks for your pull request! The team will take a look on Monday and let you know if any revisions are needed.

I'm afraid our CLA bot is punishing your use of proper punctuation. While we work on updating its expectations, would you please add another comment without the period at the end of the statement? Thanks in advance!

Copy link
Contributor

@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.

Generally LGTM: I would be happy to merge.

Please don't be intimidated by the amount of edit suggestions: most of them are for formatting changes you would not have realized to make, since this document is internally consistent.

@11t97
Copy link
Contributor Author

11t97 commented Feb 13, 2025

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

@ADubhlaoich ADubhlaoich enabled auto-merge (squash) February 17, 2025 15:51
@11t97
Copy link
Contributor Author

11t97 commented Feb 17, 2025

Hi @ADubhlaoich , thanks for resolving some conversations. I think I'm stuck. There are still 5 that require resolution before merging but they are marked as outdated and I'm not able to add them to a batch to commit. I'm investigating the GitHub help files but if you can suggest a next step for me faster, I'll take that. Thanks for helping me figure this out.

@11t97
Copy link
Contributor Author

11t97 commented Feb 17, 2025

Hi @ADubhlaoich , thanks for resolving some conversations. I think I'm stuck. There are still 5 that require resolution before merging but they are marked as outdated and I'm not able to add them to a batch to commit. I'm investigating the GitHub help files but if you can suggest a next step for me faster, I'll take that. Thanks for helping me figure this out.

I think I figured it out. Thanks!

…ability-network-load-balancer.md


update link using ../ paths
@ADubhlaoich ADubhlaoich merged commit 60bdf35 into nginx:main Feb 18, 2025
2 checks passed
@mjang mjang added community and removed in review labels Feb 18, 2025
@11t97 11t97 deleted the patch-3 branch February 18, 2025 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Analyze NGINX Plus Deployment Guide: Active-Active HA
5 participants