Skip to content

Improve user experience in Get Started guide for NGF #799

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
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

shaun-nx
Copy link

@shaun-nx shaun-nx commented Jul 9, 2025

Closes #788

Checklist

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

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

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

@shaun-nx shaun-nx requested a review from a team as a code owner July 9, 2025 10:08
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Jul 9, 2025
Copy link

github-actions bot commented Jul 9, 2025

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

@shaun-nx shaun-nx added documentation Improvements or additions to documentation customer-success and removed documentation Improvements or additions to documentation labels Jul 9, 2025
@shaun-nx
Copy link
Author

shaun-nx commented Jul 9, 2025

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

@shaun-nx shaun-nx requested review from ADubhlaoich, ciarams87, tataruty and AlexFenlon and removed request for a team July 9, 2025 10:09
Copy link

github-actions bot commented Jul 9, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/799/

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.

LGTM! Please keep conventional commits in mind when merging this for the sake of a correctly formatted title.

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.

Still generally LGTM: edit suggestions to make the explanations of the command output sequential and more concise.

Comment on lines +135 to +136
Run the below command to deploy the **coffee* application into your cluster.
This command will also create a file called `cafe.yaml` in your current working directory:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run the below command to deploy the **coffee* application into your cluster.
This command will also create a file called `cafe.yaml` in your current working directory:
Run the following command to create the file _cafe.yaml_, which is then used to deploy the *coffee* application to your cluster:

Collapsing the two sentences into one line, and phrasing it in the sequence executed.

Right now it reads as though the YAML file incidentally manifests, instead of being a requirement for the apply command.

Making similar suggestions elsewhere in the file.

Comment on lines +230 to +231
Run the below command to deploy a gateway your cluster.
This command will also create a file called `gateway.yaml` in your current working directory:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run the below command to deploy a gateway your cluster.
This command will also create a file called `gateway.yaml` in your current working directory:
Run the following command to create the file _gateway.yaml_, which is then used to deploy a Gateway to your cluster:

Comment on lines +267 to +268
Run the below command to deploy a two `HTTPRoute`resources into your cluster. One for `/coffee` and one for `/tea`.
This command will also create a file called `cafe-routes.yaml` in your current working directory:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run the below command to deploy a two `HTTPRoute`resources into your cluster. One for `/coffee` and one for `/tea`.
This command will also create a file called `cafe-routes.yaml` in your current working directory:
Run the following command to create the file _cafe-routes.yaml_. It is then used to deploy two *HTTPRoute* resources in your cluster: one each for _/coffee_ and _/tea_.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-success documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve user experience in Get Started guide for NGF
4 participants