-
Notifications
You must be signed in to change notification settings - Fork 118
Migrate docs to docs.nginx.com #1226
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
114 commits
Select commit
Hold shift + click to select a range
48a0e89
chore: hugo initialization
JTorreG cfce870
chore: fix conflicts
JTorreG 3f5ff52
feat: add hugo meta, rewrite routing-traffic doc
JTorreG 19b159d
fix: update readme for forking process
JTorreG 59b2668
feat: rename the hugo docs folder to hugo
JTorreG bb21671
chore: Merge remote-tracking branch 'origin/main' into hugo-docs
JTorreG fe9eca3
feat: update doc, move dev docs picture
JTorreG 0208b09
Update docs/README.md
JTorreG 4c1f5bc
fix: update go version. nits
JTorreG b8f155f
fix: update filename
JTorreG 5e234ef
fix: update README
JTorreG 2cb5659
fix: README update
JTorreG 62b9459
organzied the NGF docs into diataxis IA
travisamartin d6b22e5
Merge pull request #1 from Jcahilltorre/doc-269-ngf-ia-rework
travisamartin 7553608
added weights to doc folders and the changelog file
travisamartin 4efca21
Update hugo/README.md
JTorreG 82b2443
Update hugo/README.md
JTorreG c537934
fix: change docs folder to `site`
JTorreG 8251857
fix: updates to docs readme
JTorreG 5fd21af
Merge branch 'main' into hugo-docs
JTorreG 9d8c1bd
chore: add releases and tech specs dummy pages
JTorreG 6208ac9
Edits to Monitoring topic
travisamartin b74eeed
chore: edits
travisamartin 6801a6d
chore: edits
travisamartin 8160a68
chore: edits
travisamartin 67e7259
Merge pull request #2 from Jcahilltorre/doc-286-monitoring
travisamartin 4f6b26c
edits to NGF installation guide
travisamartin 395e3ab
Merge branch 'hugo-docs' into doc-285-ngf-installation
travisamartin 69f9814
fix: update caps
JTorreG 5911ef3
chore: rewrite upgrade apps without downtime
JTorreG fe8a374
fix: update documentation readme run from /site
JTorreG ff388c8
chore: disable lint line
JTorreG 0cf20ff
Merge branch 'main' into hugo-docs
JTorreG fb4f584
chore: add custom-styles shortcode
JTorreG c0b0c5c
reconfigured IA, added Installation dir
travisamartin 2bd0d5e
edits to Manifests install guide
travisamartin d30d51e
chore: edits to Heml install
travisamartin 2c10d23
chore: edits
travisamartin 3335c04
merged in changes from hugo-docs
travisamartin 4ec4980
chore: fixed broken link
travisamartin 5154845
fixed links
travisamartin 04e33c8
chore: edits
travisamartin dc68f93
chore: edits
travisamartin 0b19d01
chore: edits
travisamartin 2957ecc
chore: edits
travisamartin 54ba522
chore: edits
travisamartin f55fb98
Update site/content/installation/installing-ngf/manifests.md
travisamartin 5cb8626
Update site/content/installation/installing-ngf/helm.md
travisamartin 883d2f3
Merge pull request #3 from Jcahilltorre/doc-285-ngf-installation
travisamartin a34ed77
Update Gateway Architecture document to fit standard NGINX Formatting
ADubhlaoich d00f5d7
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
ADubhlaoich 01a4466
chore: fixed typo
travisamartin 11e84c8
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
ADubhlaoich adcd3d3
fix: typos, style fixes
JTorreG c8069f9
changed title case to sentence
travisamartin b700aa6
Merge branch 'hugo-docs' of github.com:Jcahilltorre/nginx-gateway-fab…
travisamartin 7e4da05
changed Manifests title to sentence case
travisamartin c67a46f
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG 3ee2769
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG d0fa154
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG ffa047b
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG a93eb38
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG 327fb32
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG 1b2adb8
Apply suggestions from code review
JTorreG bb41615
Update site/content/how-to/traffic-management/routing-traffic-to-your…
JTorreG 4044cf0
fix: add canary release def
JTorreG 3862610
fix: change images shortcode
JTorreG faad11c
Apply suggestions from code review
ADubhlaoich c570955
Fix broken links to reflect new file paths
ADubhlaoich 31b7a32
Fix noun capitalization inconsistencies & line formatting.
ADubhlaoich 236554e
Update CLI reference guide to match standard formatting, rephrase text
ADubhlaoich 8e70a4f
Merge pull request #4 from Jcahilltorre/review-architecture
ADubhlaoich d7c3ddd
fix: update colorbind image , bump theme
JTorreG b02fec2
chore: update hugo config
JTorreG a780230
chore: update hugo config
JTorreG 2f88c2d
chore: update hugo config files
JTorreG 4d78850
feat: update makefile
JTorreG 3619273
chore: update netlify.toml
JTorreG e726c25
fix: update makefile
JTorreG f2369d1
fix: update hugo config
JTorreG 22e0869
fix: update config file
JTorreG cbfb753
fix: fix image test
JTorreG d836d3a
fix: fix images
JTorreG 9b186b7
feat: rewrites
JTorreG 9077dd5
chore: rewrite updates
JTorreG 7ea40c0
fix: update expose doc wording
JTorreG 11f0091
fix: rewrite docs, fix order
JTorreG 56fa7ea
fix: update building the images
JTorreG 072470b
fix: Merge remote-tracking branch 'origin/main' into hugo-docs
JTorreG f82a543
fix: update new doc changes
JTorreG a6f2ad4
fix: update README
JTorreG 38ac0e3
fix: update README
JTorreG c9b99a3
Update docs/README.md
JTorreG a495f0c
Update site/content/how-to/monitoring/troubleshooting.md
JTorreG 6229e75
Update site/content/how-to/traffic-management/advanced-routing.md
JTorreG ab2ebb3
Update site/content/installation/expose-nginx-gateway-fabric.md
JTorreG c8d9c72
Update site/content/how-to/traffic-management/advanced-routing.md
JTorreG 882cf7d
Update site/content/overview/gateway-architecture.md
JTorreG 66f39a4
Update site/content/overview/gateway-architecture.md
JTorreG c2b60de
Update site/content/overview/gateway-architecture.md
JTorreG 063014e
Update site/content/reference/cli-help.md
JTorreG a9c1993
fix: fix broken shortcode
JTorreG e2fe311
fix: fix linting issues
JTorreG e558e8e
fix: fix lint issues
JTorreG e00756a
fix: fix lint issues
JTorreG 858d405
fix: fix lint issues
JTorreG e8fc9dd
chore: update upgrade apps doc
JTorreG 392e627
fix: reword sentence upgrade apps without downtime
JTorreG ebadc74
fix: various fixes
JTorreG 3c2bbfc
Update site/content/how-to/maintenance/upgrade-apps-without-downtime.md
JTorreG 55eab7e
fix: fix lint issues
JTorreG 05573e1
fix: fix lint issues
JTorreG 7e710ec
fix: fix lint issues
JTorreG 62b5f06
fix: add empty line gitignore
JTorreG File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,8 @@ | ||
# 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. | ||
JTorreG marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## 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. | ||
|
||
### Directories | ||
|
||
- [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. | ||
- [Proposals](proposals/): Enhancement proposals for new features. | ||
JTorreG marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
public | ||
.hugo_build.lock | ||
resources |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
title = "NGINX Gateway Fabric" | ||
enableGitInfo = false | ||
baseURL = "/" | ||
publishDir = "public/nginx-gateway-fabric" | ||
staticDir = ["static"] | ||
languageCode = "en-us" | ||
description = "NGINX Gateway Fabric." | ||
refLinksErrorLevel = "ERROR" | ||
enableRobotsTXT = "true" | ||
#canonifyURLs = true | ||
pluralizeListTitles = false | ||
pygmentsCodeFences = true | ||
pygmentsUseClasses = true | ||
|
||
[caches] | ||
[caches.modules] | ||
maxAge = -1 | ||
|
||
[module] | ||
[[module.imports]] | ||
path="github.com/nginxinc/nginx-hugo-theme" | ||
|
||
[markup] | ||
[markup.highlight] | ||
codeFences = true | ||
guessSyntax = true | ||
hl_Lines = "" | ||
lineNoStart = 1 | ||
lineNos = false | ||
lineNumbersInTable = true | ||
noClasses = true | ||
style = "monokai" | ||
tabWidth = 4 | ||
[markup.goldmark] | ||
[markup.goldmark.extensions] | ||
definitionList = true | ||
footnote = true | ||
linkify = true | ||
strikethrough = true | ||
table = true | ||
taskList = true | ||
typographer = true | ||
[markup.goldmark.parser] | ||
attribute = true | ||
autoHeadingID = true | ||
autoHeadingIDType = "gitlab" | ||
[markup.goldmark.renderer] | ||
hardWraps = false | ||
unsafe = true | ||
xhtml = false | ||
|
||
[params] | ||
useSectionPageLists = "false" | ||
buildtype = "webdocs" | ||
RSSLink = "/index.xml" | ||
author = "NGINX Inc." # add your company name | ||
github = "nginxinc" # add your github profile name | ||
twitter = "@nginx" # add your twitter profile | ||
#email = "" | ||
noindex_kinds = [ | ||
"taxonomy", | ||
"taxonomyTerm" | ||
] | ||
logo = "NGINX-product-icon.svg" | ||
|
||
sectionPagesMenu = "docs" | ||
|
||
ignoreFiles = [ "\\.sh$", "\\.DS_Store$", "\\.git.*$", "\\.txt$", "\\/config\\/.*", "README\\.*"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
baseURL = "https://docs-dev.nginx.com/nginx-gateway-fabric" | ||
title = "DEV -- NGINX Gateway Fabric" | ||
publishDir = "public/nginx-gateway-fabric" | ||
canonifyURLs = false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
baseURL = "https://docs.nginx.com/nginx-gateway-fabric" | ||
title = "NGINX Gateway Fabric" | ||
publishDir = "public/nginx-gateway-fabric" | ||
canonifyURLs = false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
baseURL = "https://docs-staging.nginx.com/nginx-gateway-fabric" | ||
title = "STAGING -- NGINX Gateway Fabric" | ||
publishDir = "public/nginx-gateway-fabric" | ||
canonifyURLs = false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: "Welcome to the NGINX Gateway Fabric documentation" | ||
description: | ||
linkTitle: "NGINX Gateway Fabric" | ||
menu: docs | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
docs/building-the-images.md → hugo/content/building-the-images.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 7 additions & 3 deletions
10
docs/control-plane-configuration.md → hugo/content/control-plane-configuration.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 7 additions & 3 deletions
10
docs/gateway-api-compatibility.md → hugo/content/gateway-api-compatibility.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "How-To Guides" | ||
description: | ||
linkTitle: "Guides" | ||
menu: | ||
docs: | ||
parent: NGINX Gateway Fabric | ||
--- |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.