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.

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

(cherry-pick) Add new "Get started" document (#2700) #2717

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

ADubhlaoich
Copy link
Contributor

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.

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #ISSUE

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

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.


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 ADubhlaoich requested review from a team as code owners October 22, 2024 15:54
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 22, 2024
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) October 22, 2024 15:56
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.12%. Comparing base (32a9d42) to head (4c1ef58).
Report is 1 commits behind head on release-1.4.

Additional details and impacted files
@@               Coverage Diff               @@
##           release-1.4    #2717      +/-   ##
===============================================
+ Coverage        88.84%   89.12%   +0.28%     
===============================================
  Files              100      100              
  Lines             7527     9554    +2027     
  Branches            50       50              
===============================================
+ Hits              6687     8515    +1828     
- Misses             784      983     +199     
  Partials            56       56              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ADubhlaoich ADubhlaoich merged commit c6cb8a0 into nginx:release-1.4 Oct 22, 2024
20 of 23 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/cp-get-started branch October 22, 2024 16:03
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
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants