Skip to content

Conversation

nginx-nickc
Copy link
Contributor

@nginx-nickc nginx-nickc commented Sep 9, 2025

Proposed changes

feat: new guide for working with NGINX Config in the F5 NGINX One Console

  • include how to GET NGINX Config for instances / config-sync-groups
  • how to update NGINX Config for instances / config-sync-groups using PUT, and PATCH

Closes: #1063

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@nginx-nickc nginx-nickc requested a review from a team as a code owner September 9, 2025 21:13
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-one Issues related to NGINX One Console labels Sep 9, 2025
@mjang
Copy link
Contributor

mjang commented Sep 10, 2025

General comment: @nginx-nickc , I like what you've set up. I understood what you were describing on my first read!

Some of my suggestions will be stylistic. I'm going to suggest organizing your "step 2" differently, so users can see subsections in the Table of Contents (left column) like:

  • Update all contents with PUT
  • Update a single file with PATCH
  • Set up multiple updates with PATCH

Maybe a separate reference section: (h/t Tim's suggestion)

  • How to base64 encode a JSON file
Screenshot 2025-09-10 at 11 54 36 AM

You can build docs locally, based on https://github.com/nginx/documentation/blob/main/documentation/writing-hugo.md. Alternatively, if you use a clone, our GH process will build the docs for you. I've checked memberships, and I think you should be able to use a clone of this repo.

@nginx-nickc nginx-nickc force-pushed the n1c-nginx-config-how-to branch from 1db0bb3 to 6e612b6 Compare September 10, 2025 21:48
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.

@nginx-nickc I like what you've done!

In most cases, my suggestions are stylistic. I have not tested any of the REST calls you've laid out. You can find:

Tip: for NGINX/F5 employees, we've set up PRs from repo clones to build in the frontdoor-test-docs.nginx.com domain.

Let me know what you think of my comments. If you're OK with them, I'll be happy to approve and merge :)

nginx-nickc and others added 3 commits September 11, 2025 09:00
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.

Thanks!

@nginx-nickc nginx-nickc enabled auto-merge (squash) September 11, 2025 19:14
@nginx-nickc nginx-nickc merged commit 9cc8509 into nginx:main Sep 11, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/nginx-one Issues related to NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

N1 Console. Set up a "runbook"-style how-to for managing CSGs
4 participants