Skip to content

Commit 70d9015

Browse files
authored
Remove documentation site and GitHub Action, update README references (#3047)
As of late December, NGINX has open sourced its documentation repository. The next stage of this effort is to consolidate all of the existing documentation into the single repository. This commit removes the entire `/site` folder that was being used to manage the documentation for NGINX Gateway Fabric separately from the main pipeline, as well as the GitHub action used for deployment. It also updates references to the folder to instead point towards the documentation repository, where all updates will be made in the future.
1 parent 0b2506c commit 70d9015

File tree

102 files changed

+12
-12367
lines changed

Some content is hidden

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

102 files changed

+12
-12367
lines changed

.github/workflows/docs-build-push.yml

-63
This file was deleted.

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,7 @@ internal/mode/static/nginx/modules/coverage
6161
# temporary files used for manifest generation
6262
config/base/deploy.yaml
6363
config/base/deploy.yaml.bak
64+
65+
# Temporary API documentation file, which should be committed
66+
# to the main documentation repository instead
67+
docs/api/content.md

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabr
4646
- We use [Go Modules](https://github.com/golang/go/wiki/Modules) for managing dependencies.
4747
- We use [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) for our BDD style unit
4848
tests.
49-
- The documentation website is found under `site/`.
49+
- The documentation is managed in [the NGINX documentation repository](https://github.com/nginx/documentation).
5050

5151
## Contributing
5252

@@ -97,7 +97,7 @@ Before beginning development, familiarize yourself with the following documents:
9797
conventions to follow when writing Go code for the project.
9898
- [Architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/): A high-level overview of the project's architecture.
9999
- [Design Principles](/docs/developer/design-principles.md): An overview of the project's design principles.
100-
- [NGINX Gateway Fabric Documentation](/site/README.md): An explanation of the documentation tooling and conventions.
100+
- [The NGINX documentation repository](https://github.com/nginx/documentation): The repository for NGINX documentation, which is used for the website.
101101

102102
## F5 Contributor License Agreement (CLA)
103103

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ generate-manifests: ## Generate manifests using Helm.
141141
./scripts/generate-manifests.sh
142142

143143
generate-api-docs: ## Generate API docs
144-
go run github.com/ahmetb/gen-crd-api-reference-docs@$(GEN_CRD_API_REFERENCE_DOCS_VERSION) -config site/config/api/config.json -template-dir site/config/api -out-file site/content/reference/api.md -api-dir "github.com/nginx/nginx-gateway-fabric/apis"
144+
go run github.com/ahmetb/gen-crd-api-reference-docs@$(GEN_CRD_API_REFERENCE_DOCS_VERSION) -config docs/api/config.json -template-dir docs/api -out-file docs/api/content.md -api-dir "github.com/nginx/nginx-gateway-fabric/apis"
145145

146146
.PHONY: generate-helm-docs
147147
generate-helm-docs: ## Generate the Helm chart documentation

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a
2222

2323
## Getting Started
2424

25-
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/).
25+
1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/).
2626
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
2727
3. Deploy various [examples](examples).
2828
4. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).

docs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ _Please note: You can find the user documentation for NGINX Gateway Fabric in th
88

99
- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
1010
- [Proposals](proposals/): Enhancement proposals for new features.
11+
- [API](api/): The files for generating API documentation, used in the Makefile
File renamed without changes.
File renamed without changes.

site/config/api/pkg.tpl renamed to docs/api/pkg.tpl

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
---
33
title: "API reference"
44
weight: 100
5-
toc: false
5+
type: reference
6+
product: NGF
7+
docs: DOCS-000
68
---
79

810
## Overview
File renamed without changes.

site/.gitignore

-3
This file was deleted.

site/.markdownlint.json

-22
This file was deleted.

site/Makefile

-64
This file was deleted.

site/README.md

-164
This file was deleted.

0 commit comments

Comments
 (0)