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.

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

Migrate docs to docs.nginx.com #1226

Merged
merged 114 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from 111 commits
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
48a0e89
chore: hugo initialization
Jcahilltorre Nov 2, 2023
cfce870
chore: fix conflicts
Jcahilltorre Nov 6, 2023
3f5ff52
feat: add hugo meta, rewrite routing-traffic doc
Jcahilltorre Nov 6, 2023
19b159d
fix: update readme for forking process
Jcahilltorre Nov 6, 2023
59b2668
feat: rename the hugo docs folder to hugo
Jcahilltorre Nov 8, 2023
bb21671
chore: Merge remote-tracking branch 'origin/main' into hugo-docs
Jcahilltorre Nov 9, 2023
fe9eca3
feat: update doc, move dev docs picture
Jcahilltorre Nov 9, 2023
0208b09
Update docs/README.md
Jcahilltorre Nov 9, 2023
4c1f5bc
fix: update go version. nits
Jcahilltorre Nov 9, 2023
b8f155f
fix: update filename
Jcahilltorre Nov 9, 2023
5e234ef
fix: update README
Jcahilltorre Nov 9, 2023
2cb5659
fix: README update
Jcahilltorre Nov 9, 2023
62b9459
organzied the NGF docs into diataxis IA
travisamartin Nov 9, 2023
d6b22e5
Merge pull request #1 from Jcahilltorre/doc-269-ngf-ia-rework
travisamartin Nov 9, 2023
7553608
added weights to doc folders and the changelog file
travisamartin Nov 9, 2023
4efca21
Update hugo/README.md
Jcahilltorre Nov 14, 2023
82b2443
Update hugo/README.md
Jcahilltorre Nov 14, 2023
c537934
fix: change docs folder to `site`
Jcahilltorre Nov 14, 2023
8251857
fix: updates to docs readme
Jcahilltorre Nov 14, 2023
5fd21af
Merge branch 'main' into hugo-docs
Jcahilltorre Nov 14, 2023
9d8c1bd
chore: add releases and tech specs dummy pages
Jcahilltorre Nov 14, 2023
6208ac9
Edits to Monitoring topic
travisamartin Nov 15, 2023
b74eeed
chore: edits
travisamartin Nov 15, 2023
6801a6d
chore: edits
travisamartin Nov 15, 2023
8160a68
chore: edits
travisamartin Nov 15, 2023
67e7259
Merge pull request #2 from Jcahilltorre/doc-286-monitoring
travisamartin Nov 16, 2023
4f6b26c
edits to NGF installation guide
travisamartin Nov 16, 2023
395e3ab
Merge branch 'hugo-docs' into doc-285-ngf-installation
travisamartin Nov 16, 2023
69f9814
fix: update caps
Jcahilltorre Nov 16, 2023
5911ef3
chore: rewrite upgrade apps without downtime
Jcahilltorre Nov 16, 2023
fe8a374
fix: update documentation readme run from /site
Jcahilltorre Nov 16, 2023
ff388c8
chore: disable lint line
Jcahilltorre Nov 16, 2023
0cf20ff
Merge branch 'main' into hugo-docs
Jcahilltorre Nov 16, 2023
fb4f584
chore: add custom-styles shortcode
Jcahilltorre Nov 16, 2023
c0b0c5c
reconfigured IA, added Installation dir
travisamartin Nov 17, 2023
2bd0d5e
edits to Manifests install guide
travisamartin Nov 17, 2023
d30d51e
chore: edits to Heml install
travisamartin Nov 18, 2023
2c10d23
chore: edits
travisamartin Nov 18, 2023
3335c04
merged in changes from hugo-docs
travisamartin Nov 18, 2023
4ec4980
chore: fixed broken link
travisamartin Nov 18, 2023
5154845
fixed links
travisamartin Nov 18, 2023
04e33c8
chore: edits
travisamartin Nov 18, 2023
dc68f93
chore: edits
travisamartin Nov 18, 2023
0b19d01
chore: edits
travisamartin Nov 18, 2023
2957ecc
chore: edits
travisamartin Nov 18, 2023
54ba522
chore: edits
travisamartin Nov 20, 2023
f55fb98
Update site/content/installation/installing-ngf/manifests.md
travisamartin Nov 20, 2023
5cb8626
Update site/content/installation/installing-ngf/helm.md
travisamartin Nov 20, 2023
883d2f3
Merge pull request #3 from Jcahilltorre/doc-285-ngf-installation
travisamartin Nov 20, 2023
a34ed77
Update Gateway Architecture document to fit standard NGINX Formatting
ADubhlaoich Nov 20, 2023
d00f5d7
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
ADubhlaoich Nov 20, 2023
01a4466
chore: fixed typo
travisamartin Nov 20, 2023
11e84c8
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
ADubhlaoich Nov 20, 2023
adcd3d3
fix: typos, style fixes
Jcahilltorre Nov 20, 2023
c8069f9
changed title case to sentence
travisamartin Nov 20, 2023
b700aa6
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
travisamartin Nov 20, 2023
7e4da05
changed Manifests title to sentence case
travisamartin Nov 20, 2023
c67a46f
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
3ee2769
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
d0fa154
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
ffa047b
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
a93eb38
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
327fb32
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 20, 2023
1b2adb8
Apply suggestions from code review
Jcahilltorre Nov 20, 2023
bb41615
Update site/content/how-to/traffic-management/routing-traffic-to-your…
Jcahilltorre Nov 20, 2023
4044cf0
fix: add canary release def
Jcahilltorre Nov 20, 2023
3862610
fix: change images shortcode
Jcahilltorre Nov 20, 2023
faad11c
Apply suggestions from code review
ADubhlaoich Nov 21, 2023
c570955
Fix broken links to reflect new file paths
ADubhlaoich Nov 21, 2023
31b7a32
Fix noun capitalization inconsistencies & line formatting.
ADubhlaoich Nov 21, 2023
236554e
Update CLI reference guide to match standard formatting, rephrase text
ADubhlaoich Nov 21, 2023
8e70a4f
Merge pull request #4 from Jcahilltorre/review-architecture
ADubhlaoich Nov 21, 2023
d7c3ddd
fix: update colorbind image , bump theme
Jcahilltorre Nov 21, 2023
b02fec2
chore: update hugo config
Jcahilltorre Nov 22, 2023
a780230
chore: update hugo config
Jcahilltorre Nov 22, 2023
2f88c2d
chore: update hugo config files
Jcahilltorre Nov 22, 2023
4d78850
feat: update makefile
Jcahilltorre Nov 22, 2023
3619273
chore: update netlify.toml
Jcahilltorre Nov 22, 2023
e726c25
fix: update makefile
Jcahilltorre Nov 22, 2023
f2369d1
fix: update hugo config
Jcahilltorre Nov 22, 2023
22e0869
fix: update config file
Jcahilltorre Nov 22, 2023
cbfb753
fix: fix image test
Jcahilltorre Nov 22, 2023
d836d3a
fix: fix images
Jcahilltorre Nov 22, 2023
9b186b7
feat: rewrites
Jcahilltorre Nov 23, 2023
9077dd5
chore: rewrite updates
Jcahilltorre Nov 23, 2023
7ea40c0
fix: update expose doc wording
Jcahilltorre Nov 27, 2023
11f0091
fix: rewrite docs, fix order
Jcahilltorre Nov 28, 2023
56fa7ea
fix: update building the images
Jcahilltorre Nov 28, 2023
072470b
fix: Merge remote-tracking branch 'origin/main' into hugo-docs
Jcahilltorre Nov 28, 2023
f82a543
fix: update new doc changes
Jcahilltorre Nov 28, 2023
a6f2ad4
fix: update README
Jcahilltorre Nov 28, 2023
38ac0e3
fix: update README
Jcahilltorre Nov 28, 2023
c9b99a3
Update docs/README.md
Jcahilltorre Nov 28, 2023
a495f0c
Update site/content/how-to/monitoring/troubleshooting.md
Jcahilltorre Nov 28, 2023
6229e75
Update site/content/how-to/traffic-management/advanced-routing.md
Jcahilltorre Nov 28, 2023
ab2ebb3
Update site/content/installation/expose-nginx-gateway-fabric.md
Jcahilltorre Nov 28, 2023
c8d9c72
Update site/content/how-to/traffic-management/advanced-routing.md
Jcahilltorre Nov 28, 2023
882cf7d
Update site/content/overview/gateway-architecture.md
Jcahilltorre Nov 28, 2023
66f39a4
Update site/content/overview/gateway-architecture.md
Jcahilltorre Nov 28, 2023
c2b60de
Update site/content/overview/gateway-architecture.md
Jcahilltorre Nov 28, 2023
063014e
Update site/content/reference/cli-help.md
Jcahilltorre Nov 28, 2023
a9c1993
fix: fix broken shortcode
Jcahilltorre Nov 28, 2023
e2fe311
fix: fix linting issues
Jcahilltorre Nov 29, 2023
e558e8e
fix: fix lint issues
Jcahilltorre Nov 29, 2023
e00756a
fix: fix lint issues
Jcahilltorre Nov 29, 2023
858d405
fix: fix lint issues
Jcahilltorre Nov 29, 2023
e8fc9dd
chore: update upgrade apps doc
Jcahilltorre Nov 29, 2023
392e627
fix: reword sentence upgrade apps without downtime
Jcahilltorre Nov 29, 2023
ebadc74
fix: various fixes
Jcahilltorre Nov 29, 2023
3c2bbfc
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
Jcahilltorre Nov 29, 2023
55eab7e
fix: fix lint issues
Jcahilltorre Nov 29, 2023
05573e1
fix: fix lint issues
Jcahilltorre Nov 29, 2023
7e710ec
fix: fix lint issues
Jcahilltorre Nov 29, 2023
62b5f06
fix: add empty line gitignore
Jcahilltorre Nov 29, 2023
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
5 changes: 1 addition & 4 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ config:
style: dash
no-hard-tabs: false
no-multiple-blanks: false
line-length:
line_length: 120
code_blocks: false
tables: false
line-length: false
blanks-around-headers: false
no-duplicate-heading:
siblings_only: true
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,21 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy,
on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.

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

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

## Getting Started

1. [Quick Start on a kind cluster](docs/running-on-kind.md).
2. [Install](docs/installation.md) NGINX Gateway Fabric.
3. [Build](docs/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind.md).
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
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
available
on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric).
4. Deploy various [examples](examples).
5. Read our [guides](/docs/guides).
5. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).

You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website.

## NGINX Gateway Fabric Releases

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

## Troubleshooting

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

## Contacts

Expand Down
23 changes: 3 additions & 20 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,10 @@
# NGINX Gateway Fabric Documentation

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

## Contents

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

### Directories
## Contents

- [Guides](guides): Guides about configuring NGINX Gateway Fabric for various use cases.
- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
- [Proposals](proposals/): Enhancement proposals for new features.
160 changes: 0 additions & 160 deletions docs/architecture.md

This file was deleted.

Loading
Loading