-
Notifications
You must be signed in to change notification settings - Fork 112
docs: added guide for working with NGINX Configs #1086
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
Conversation
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:
Maybe a separate reference section: (h/t Tim's suggestion)
![]() 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. |
1db0bb3
to
6e612b6
Compare
There was a problem hiding this 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:
- Our style guide: https://github.com/nginx/documentation/blob/main/documentation/style-guide.md
- Instructions for building locally: https://github.com/nginx/documentation/blob/main/documentation/writing-hugo.md
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 :)
Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Proposed changes
feat: new guide for working with NGINX Config in the F5 NGINX One Console
PUT
, andPATCH
Closes: #1063
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩