Skip to content

Commit 8cd9d52

Browse files
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]>
1 parent 0d8b9a0 commit 8cd9d52

File tree

9 files changed

+516
-130
lines changed

9 files changed

+516
-130
lines changed

site/content/get-started.md

Lines changed: 508 additions & 0 deletions
Large diffs are not rendered by default.

site/content/how-to/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
title: "How-to guides"
3-
weight: 300
3+
weight: 400
44
---

site/content/installation/_index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
---
22
title: "Installation"
3-
description:
4-
weight: 200
5-
linkTitle: "Installation"
6-
menu:
7-
docs:
8-
parent: NGINX Gateway Fabric
3+
weight: 300
94
---

site/content/installation/running-on-kind.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

site/content/reference/_index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
---
22
title: "Reference"
3-
description:
4-
weight: 400
5-
linkTitle: "Reference"
6-
menu:
7-
docs:
8-
parent: NGINX Gateway Fabric
3+
weight: 500
94
---

site/content/releases.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
title: "Releases"
3-
draft: false
43
description: "NGINX Gateway Fabric releases."
5-
weight: 1200
64
toc: true
7-
tags: [ "docs" ]
5+
weight: 700
86
docs: "DOCS-1359"
97
---
108

site/content/support.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
title: "Support"
3-
draft: false
4-
weight: 1100
53
toc: true
6-
tags: [ "docs" ]
4+
weight: 600
75
docs: "DOCS-1411"
86
---
97

site/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com/nginxinc/nginx-gateway-fabric/site
22

33
go 1.21
44

5-
require github.com/nginxinc/nginx-hugo-theme v0.41.20 // indirect
5+
require github.com/nginxinc/nginx-hugo-theme v0.41.22 // indirect

site/go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
github.com/nginxinc/nginx-hugo-theme v0.41.20 h1:6BJGRGdHW17OpkC4qbcHARo9TRrJPFrALBjFltwedf8=
2-
github.com/nginxinc/nginx-hugo-theme v0.41.20/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
1+
github.com/nginxinc/nginx-hugo-theme v0.41.22 h1:Gb/OLbpumNqp8vOPkZzO2GmgPDRd1yr2tWHWUBHg8BA=
2+
github.com/nginxinc/nginx-hugo-theme v0.41.22/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 commit comments

Comments
 (0)