Skip to content

Commit

Permalink
(cherry-pick) Add new "Get started" document (#2700) (#2717)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
ADubhlaoich and sjberman authored Oct 22, 2024
1 parent 32a9d42 commit c6cb8a0
Show file tree
Hide file tree
Showing 9 changed files with 516 additions and 130 deletions.
508 changes: 508 additions & 0 deletions site/content/get-started.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion site/content/how-to/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: "How-to guides"
weight: 300
weight: 400
---
7 changes: 1 addition & 6 deletions site/content/installation/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
title: "Installation"
description:
weight: 200
linkTitle: "Installation"
menu:
docs:
parent: NGINX Gateway Fabric
weight: 300
---
108 changes: 0 additions & 108 deletions site/content/installation/running-on-kind.md

This file was deleted.

7 changes: 1 addition & 6 deletions site/content/reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
title: "Reference"
description:
weight: 400
linkTitle: "Reference"
menu:
docs:
parent: NGINX Gateway Fabric
weight: 500
---
4 changes: 1 addition & 3 deletions site/content/releases.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: "Releases"
draft: false
description: "NGINX Gateway Fabric releases."
weight: 1200
toc: true
tags: [ "docs" ]
weight: 700
docs: "DOCS-1359"
---

Expand Down
4 changes: 1 addition & 3 deletions site/content/support.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: "Support"
draft: false
weight: 1100
toc: true
tags: [ "docs" ]
weight: 600
docs: "DOCS-1411"
---

Expand Down
2 changes: 1 addition & 1 deletion site/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ module github.com/nginxinc/nginx-gateway-fabric/site

go 1.21

require github.com/nginxinc/nginx-hugo-theme v0.41.20 // indirect
require github.com/nginxinc/nginx-hugo-theme v0.41.22 // indirect
4 changes: 2 additions & 2 deletions site/go.sum
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
github.com/nginxinc/nginx-hugo-theme v0.41.20 h1:6BJGRGdHW17OpkC4qbcHARo9TRrJPFrALBjFltwedf8=
github.com/nginxinc/nginx-hugo-theme v0.41.20/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
github.com/nginxinc/nginx-hugo-theme v0.41.22 h1:Gb/OLbpumNqp8vOPkZzO2GmgPDRd1yr2tWHWUBHg8BA=
github.com/nginxinc/nginx-hugo-theme v0.41.22/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 comments on commit c6cb8a0

Please sign in to comment.