Skip to content

Commit 110df75

Browse files
JTorreGtravisamartinkate-osbornADubhlaoich
authored
Migrate docs to docs.nginx.com (#1226)
Change docs structure and add the required files to build documentation Hugo and publish with Netlify Rewrite existing docs to work with Hugo --------- Co-authored-by: Travis Martin <t.martin@f5.com> Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com> Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com> Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com> Co-authored-by: Alan Dooley <a.dooley@f5.com>
1 parent 7ad0887 commit 110df75

File tree

75 files changed

+2020
-1409
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2020
-1409
lines changed

.markdownlint-cli2.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@ config:
55
style: dash
66
no-hard-tabs: false
77
no-multiple-blanks: false
8-
line-length:
9-
line_length: 120
10-
code_blocks: false
11-
tables: false
8+
line-length: false
129
blanks-around-headers: false
1310
no-duplicate-heading:
1411
siblings_only: true

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,21 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy,
1010
on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.
1111

1212
For a list of supported Gateway API resources and features, see
13-
the [Gateway API Compatibility](docs/gateway-api-compatibility.md) doc.
13+
the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility.md) doc.
1414

15-
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](/docs/architecture.md).
15+
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture.md).
1616

1717
## Getting Started
1818

19-
1. [Quick Start on a kind cluster](docs/running-on-kind.md).
20-
2. [Install](docs/installation.md) NGINX Gateway Fabric.
21-
3. [Build](docs/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image
19+
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind.md).
20+
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
21+
3. [Build](https://docs.nginx.com/nginx-gateway-fabric/installation/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image
2222
available
2323
on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric).
2424
4. Deploy various [examples](examples).
25-
5. Read our [guides](/docs/guides).
25+
5. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).
26+
27+
You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website.
2628

2729
## NGINX Gateway Fabric Releases
2830

@@ -99,7 +101,7 @@ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-gateway-fabric:edge --fo
99101

100102
## Troubleshooting
101103

102-
For troubleshooting help, see the [Troubleshooting](/docs/troubleshooting.md) document.
104+
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting.md) document.
103105

104106
## Contacts
105107

docs/README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,10 @@
11
# NGINX Gateway Fabric Documentation
22

3-
This directory contains all of the documentation relating to NGINX Gateway Fabric.
3+
This directory contains the developer documentation and the enhancement proposals relating to NGINX Gateway Fabric.
44

5-
## Contents
6-
7-
- [Architecture](architecture.md): An overview of the architecture and design principles of NGINX Gateway Fabric.
8-
- [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Gateway
9-
Fabric supports and the extent of that support.
10-
- [Installation](installation.md): Walkthrough on how to install NGINX Gateway Fabric on a generic Kubernetes cluster.
11-
- [Resource Validation](resource-validation.md): Describes how NGINX Gateway Fabric validates Gateway API
12-
resources.
13-
- [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX
14-
Gateway Fabric control plane configuration.
15-
- [Building the Images](building-the-images.md): Steps on how to build the NGINX Gateway Fabric container images
16-
yourself.
17-
- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Gateway Fabric on a `kind` cluster.
18-
- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-gateway-fabric`
19-
container.
20-
- [Monitoring](monitoring.md): Information on monitoring NGINX Gateway Fabric using Prometheus metrics.
21-
- [Troubleshooting](troubleshooting.md): Troubleshooting guide for common or known issues.
5+
_Please note: You can find the user documentation for NGINX Gateway Fabric in the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website._
226

23-
### Directories
7+
## Contents
248

25-
- [Guides](guides): Guides about configuring NGINX Gateway Fabric for various use cases.
269
- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
2710
- [Proposals](proposals/): Enhancement proposals for new features.

docs/architecture.md

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

0 commit comments

Comments
 (0)