Add new "Get started" document #2700
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub. As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname. Both of these could instead be added to a general network configuration document.
github-actions
bot
added
the
documentation
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2700 +/- ##
=======================================
Coverage 89.38% 89.38%
=======================================
Files 110 110
Lines 10913 10913
Branches 50 50
=======================================
Hits 9755 9755
Misses 1100 1100
Partials 58 58 ☔ View full report in Codecov by Sentry. |
sjberman
reviewed
Oct 18, 2024
bjee19
reviewed
Oct 18, 2024
bjee19
reviewed
Oct 18, 2024
bjee19
reviewed
Oct 18, 2024
Co-authored-by: Saylor Berman <[email protected]>
…k into docs/get-started
|
Incorporated feedback into the PR. Much of it was carelessness on my part to get the PR up for visibility: my apologies. |
sjberman
reviewed
Oct 21, 2024
sjberman
reviewed
Oct 21, 2024
bjee19
approved these changes
Oct 21, 2024
|
@conradwt As the person who filed the original issue, any thoughts? |
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
sjberman
approved these changes
Oct 22, 2024
ADubhlaoich
added a commit
to ADubhlaoich/ngf-doc-work
that referenced
this pull request
Oct 22, 2024
This commit adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub. As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname. Both of these could instead be added to a general network configuration document. Co-authored-by: Saylor Berman <[email protected]>
ADubhlaoich
added a commit
to ADubhlaoich/ngf-doc-work
that referenced
this pull request
Oct 22, 2024
This commit adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub. As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname. Both of these could instead be added to a general network configuration document. Co-authored-by: Saylor Berman <[email protected]>
ADubhlaoich
added a commit
that referenced
this pull request
Oct 22, 2024
Add new "Get started" document (#2700) This commit adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub. As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname. Both of these could instead be added to a general network configuration document. Co-authored-by: Saylor Berman <[email protected]>
|
@ADubhlaoich I believe that I found it by using steps in the 'Getting Started' on this repo. Let me go through it and I'll report back to you. |
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
This commit adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub. As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname. Both of these could instead be added to a general network configuration document. Co-authored-by: Saylor Berman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This pull request adds a new "Get started" document for NGINX Gateway Fabric. It re-orders the top level page so that it is second after "Overview" as a means to get a reader started as quickly as possible, and is a combination of the existing kind guide, a Helm installation path and the cafe-example on GitHub.
As part of this work, the original kind guide has been deleted: the only context lost is regarding port forwarding, which this new document mentions not requiring. The README for the cafe-example could also be stripped down as a result: the step "skipped" regards how to use a different hostname.
Both of these could instead be added to a general network configuration document.
Closes #2350
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.