Skip to content

Commit b16d532

Browse files
committed
feat: Update NGF 1.6 doc links to be old code repository branch
1 parent 0d876be commit b16d532

File tree

2 files changed

+48
-7
lines changed

2 files changed

+48
-7
lines changed

_banners/ngf-2.0-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
NGINX Gateway Fabric 2.0 has released! Follow [this guide]({{< ref "/ngf/install/upgrade-2.0" >}}) to upgrade from 1.x to 2.0.
44

5-
For 1.x, checkout [an older version](https://github.com/nginx/documentation/commit/0be97114d93be0f44acff8711f31bf0b6448dd94) of documentation.
5+
For 1.x, checkout [an older version](https://github.com/nginx/nginx-gateway-fabric/tree/release-1.6) of documentation.
66

77
{{< /banner >}}

content/ngf/install/upgrade-2.0.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ docs: DOCS-0000
99

1010
This guide provides step-by-step instructions for upgrading NGINX Gateway Fabric from version 1.x to 2.x, highlighting key architectural changes, expected downtime, and important considerations for custom resource definitions (CRDs).
1111

12-
13-
### Upgrade from v1.x to v2.x
12+
## Upgrade from v1.x to v2.x
1413

1514
To upgrade NGINX Gateway Fabric from version 1.x to the new architecture in version 2.x, you must uninstall the existing NGINX Gateway Fabric CRDs and deployment, and perform a fresh installation. This will cause brief downtime during the upgrade process.
1615

1716
{{<note>}} You do not need to uninstall the Gateway API CRDs during the upgrade. These resources are compatible with the new NGINX Gateway Fabric version. {{</note>}}
1817

19-
#### Uninstall NGINX Gateway Fabric v1.x
18+
### Uninstall NGINX Gateway Fabric v1.x
2019

2120
To remove the previous version 1.x of NGINX Gateway Fabric, follow these steps:
2221

@@ -70,8 +69,7 @@ For additional customization options during the installation process using manif
7069

7170
{{</tabs>}}
7271

73-
74-
### Architecture changes
72+
## Architecture changes
7573

7674
With this release, NGINX Gateway Fabric adopts a new architecture that separates the control plane and data plane into independent deployments. This separation improves scalability, security, and operational clarity.
7775

@@ -85,8 +83,51 @@ New fields have been added to the `NginxProxy` resource to configure infrastruct
8583

8684
For detailed instructions on how to modify these settings, refer to the [Configure infrastructure-related settings]({{< ref "/ngf/how-to/data-plane-configuration.md#configure-infrastructure-related-settings" >}}) guide.
8785

86+
## Access NGINX Gateway Fabric 1.x documentation
87+
88+
The documentation website is intended for the latest version of NGINX Gateway Fabric.
89+
90+
To review documentation prior to 2.x, check out the desired release branch (Such as _release-1.6_):
91+
92+
```shell
93+
git clone [email protected]:nginx/nginx-gateway-fabric.git
94+
git checkout release-1.6
95+
```
96+
97+
To review the documentation in a local webserver, run _make watch_ in the _/site_ folder:
98+
99+
```shell
100+
cd site
101+
make watch
102+
```
103+
```text
104+
Hugo is available and has a version greater than 133. Proceeding with build.
105+
hugo --bind 0.0.0.0 -p 1313 server --disableFastRender
106+
Watching for changes in /home/<your-user>/nginx-gateway-fabric/site/{content,layouts,static}
107+
Watching for config changes in /home/<your-user>/nginx-gateway-fabric/site/config/_default, /home/<your-user>/nginx-gateway-fabric/site/config/development, /home/<your-user>/nginx-gateway-fabric/site/go.mod
108+
Start building sites …
109+
hugo v0.135.0-f30603c47f5205e30ef83c70419f57d7eb7175ab linux/amd64 BuildDate=2024-09-27T13:17:08Z VendorInfo=gohugoio
110+
111+
112+
| EN
113+
-------------------+------
114+
Pages | 72
115+
Paginator pages | 0
116+
Non-page files | 0
117+
Static files | 176
118+
Processed images | 0
119+
Aliases | 9
120+
Cleaned | 0
121+
122+
Built in 213 ms
123+
Environment: "development"
124+
Serving pages from disk
125+
Web Server is available
126+
```
127+
128+
You can then follow [this localhost link](http://localhost:1313/nginx-gateway-fabric/) for 1.x NGINX Gateway Fabric documentation.
88129

89-
### Key links for the version 2.x update
130+
## Key links for the version 2.x update
90131

91132
- To read more on [modifying data plane configuration]({{< ref "/ngf/how-to/data-plane-configuration.md" >}}).
92133
- To learn more about [deploying a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}}).

0 commit comments

Comments
 (0)