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

reframed NGF getting started as a deployment guide #313

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

travisamartin
Copy link
Contributor

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.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

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 and CHANGELOG.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.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Mar 24, 2025
Copy link

Deploy Preview will be available once build job completes!

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

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.

Generally LGTM, with two points:

  • Moving the document up a folder means the weight on all other top level items should be adjusted
  • This PR is in draft state, so the stakeholders from NGF are not aware of its existence. Nothing in the PR description justifies the changes, so there is no context to why this change is being made.

@@ -1,25 +1,23 @@
---
title: Get started
title: Deploy on kind for demos
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this change going to prevent users from visiting this doc now?

There are definitely smaller scale users who could utilize this guide for their own setups, but this title may not draw them in as we previously intended.

If I have the thought "I just want to quickly get a basic NGF installation up and running", a guide that says "Get Started" feels more likely to get my attention than this new title.


For standard deployments, you should read the [Install NGINX Gateway Fabric]({{< ref "/ngf/installation/installing-ngf" >}}) section.
{{< /important >}}
This guide walks you through a demo deployment of NGINX Gateway Fabric using a local [kind (Kubernetes in Docker)](https://kind.sigs.k8s.io/) cluster. This setup is useful for testing and evaluation but isn't intended for production use.
Copy link
Contributor

Choose a reason for hiding this comment

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

By removing the link to the standard installation guide here, are users who come to this guide and realize it's not what they want going to be confused as to where to go next?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm concerned about this too: benefit of the doubt suggests maybe the title change suggests the user flow leads them to a different document before they get to this point.

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 product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants