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

reframed NGF getting started as a deployment guide #313

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

reframed NGF getting started as a deployment guide #313

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9ee03f
reframed NGF getting started as a deployment guide
travisamartin Mar 24, 2025
4183bc3
Merge branch 'main' into rename-to-deployment-guides
ADubhlaoich Mar 25, 2025
f82bd6d
Merge branch 'main' into rename-to-deployment-guides
ADubhlaoich Mar 28, 2025
decc571
Merge branch 'main' into rename-to-deployment-guides
ADubhlaoich Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions content/ngf/get-started.md → content/ngf/installation/deploy-on-kind.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

weight: 200
toc: true
type: how-to
product: NGF
docs: DOCS-000
---

{{< important >}}
This document is for trying out NGINX Gateway Fabric, and not intended for a production environment.
## Overview

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.


This is a guide for getting started with NGINX Gateway Fabric. It explains how to:
You'll learn how to:

- Set up a [kind (Kubernetes in Docker)](https://kind.sigs.k8s.io/) cluster
- Install [NGINX Gateway Fabric](https://github.com/nginx/nginx-gateway-fabric) with [NGINX](https://nginx.org/)
- Test NGINX Gateway Fabric with an example application
- Set up a kind cluster
- Install NGINX Gateway Fabric with [NGINX](https://nginx.org/)
- Deploy and test an example application

By following the steps in order, you will finish with a functional NGINX Gateway Fabric cluster.
After you complete the steps, you'll have a working NGINX Gateway Fabric environment running locally.

---

Expand Down