Skip to content

Review NGINX Plus Deployment Guide: F5 big IP config #362

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

Open
mjang opened this issue Apr 3, 2025 · 3 comments
Open

Review NGINX Plus Deployment Guide: F5 big IP config #362

mjang opened this issue Apr 3, 2025 · 3 comments
Assignees
Labels
community good first issue Good for newcomers product/nginx-one NGINX One Console

Comments

@mjang
Copy link
Contributor

mjang commented Apr 3, 2025

This page, https://docs.nginx.com/nginx/deployment-guides/migrate-hardware-adc/f5-big-ip-configuration/, is somewhat "difficult" to read. (Flesch-Kincaid estimate: 12.33)

You can review and edit the source code for the page directly in our repository. You can edit it directly, as described in Editing files.

Alternatively, If you know Git, you're welcome to fork the repository and use your skills to set up a Pull request.

We need to audit this page.

Here's what we'd like you to do (tasks):

  • Audit screenshots

    • Update if they're out of date
    • Evaluate the screenshots:
      • Do they include too much info, such as Personally Identifying Information
      • Do we need all the information in the screenshot
      • Do we even need the screenshot, since it's from "someone else's" UI
        • If you propose removing the screenshot, include replacement text (if/as required)
  • Evaluate the page for readability

If you're not (yet) comfortable with Git, you're welcome to post your answers to this issue in a Discussion.

  • We'll be happy to give you credit!

If you haven't been able to do everything in this issue, that's OK. We appreciate all the help that we can get.

@mjang mjang added good first issue Good for newcomers community product/nginx-one NGINX One Console labels Apr 3, 2025
@rlstern
Copy link

rlstern commented May 4, 2025

Please assign this to me

@rlstern
Copy link

rlstern commented May 4, 2025

I attempted to increase the readability of the beginning explanation by simplifying sentences, but this will require review by a technical expert, as the meanings could have changed over the course of simplifying. In some cases, the pronoun in the sentence was indirect, so review is needed to determine the proper noun to which it refers. In these cases, I have bolded where clarity is needed. I also bolded one instance of an undefined acronym.

Readability Improvement Draft - F5 big IP config.docx

No changes were made past the section “Definitions of Networking Concepts“.

Note - none of the images were audited.

@mjang
Copy link
Contributor Author

mjang commented May 7, 2025

@rlstern thanks so much for your work! Your doc file is a permanent part of this issue.

If you'd like to take this further, you could use the steps described in this issue to start suggesting changes to our current documentation.

Alternatively, you could:

If you want to take "the next step," I'll be happy to help you with details and any questions you may have about the process. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community good first issue Good for newcomers product/nginx-one NGINX One Console
Projects
None yet
Development

No branches or pull requests

2 participants