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.

Sign up for GitHub

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

Jump to bottom

Documentation: Kubernetes Object Capitalization and Gateway Field Formatting #550

Closed
ja20222 opened this issue Apr 5, 2023 · 0 comments · Fixed by #869
Closed

Documentation: Kubernetes Object Capitalization and Gateway Field Formatting #550

ja20222 opened this issue Apr 5, 2023 · 0 comments · Fixed by #869
Assignees
@sjberman
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented.
Milestone
v0.6.0

Comments

@ja20222
Copy link

ja20222 commented Apr 5, 2023 •
edited by mpstefan
Loading

As a user of NGINX Kubernetes Gateway
I want the NKG documentation to capitalize Kubernetes objects
So that the documentation is easier to read and I can make the the connection between what is discussed and the specific Kubernetes implementation.

Acceptance

  • Whenever a Kubernetes object is referred to in NKG documentation, that object name is capitalized.
  • Gateway fields should use ` to denote we are referring to a specific field that the user can change.
@mpstefan mpstefan added the documentation Improvements or additions to documentation label Jun 9, 2023
@mpstefan mpstefan added this to the v0.6.0 milestone Jun 21, 2023
@mpstefan mpstefan mentioned this issue Jun 22, 2023
Closed
@mpstefan mpstefan changed the title Documentation: When referring to kubernetes objects, they should be capitalized like Service Documentation: Kubernetes Object Capitalization and Gateway Field Formatting Jul 12, 2023
@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Jul 12, 2023
@sjberman sjberman self-assigned this Jul 17, 2023
@sjberman sjberman mentioned this issue Jul 17, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sjberman sjberman

Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented.
Projects
None yet
Milestone
v0.6.0
Development

Successfully merging a pull request may close this issue.

Update formatting for names and output in docs sjberman/nginx-gateway-fabric
3 participants
@mpstefan @sjberman @ja20222