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

Remove documentation site and GitHub Action, update README references #3047

Merged
merged 13 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
63 changes: 0 additions & 63 deletions .github/workflows/docs-build-push.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,7 @@ internal/mode/static/nginx/modules/coverage
# temporary files used for manifest generation
config/base/deploy.yaml
config/base/deploy.yaml.bak

# Temporary API documentation file, which should be committed
# to the main documentation repository instead
docs/api/content.md
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabr
- We use [Go Modules](https://github.com/golang/go/wiki/Modules) for managing dependencies.
- We use [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) for our BDD style unit
tests.
- The documentation website is found under `site/`.
- The documentation is managed in [the NGINX documentation repository](https://github.com/nginx/documentation).

## Contributing

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

## F5 Contributor License Agreement (CLA)

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ generate-manifests: ## Generate manifests using Helm.
./scripts/generate-manifests.sh

generate-api-docs: ## Generate API docs
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"
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"

.PHONY: generate-helm-docs
generate-helm-docs: ## Generate the Helm chart documentation
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a

## Getting Started

1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/).
1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/).
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
3. Deploy various [examples](examples).
4. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).
Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ _Please note: You can find the user documentation for NGINX Gateway Fabric in th

- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
- [Proposals](proposals/): Enhancement proposals for new features.
- [API](api/): The files for generating API documentation, used in the Makefile
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion site/config/api/pkg.tpl → docs/api/pkg.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
---
title: "API reference"
weight: 100
toc: false
type: reference
product: NGF
docs: DOCS-000
---

## Overview
Expand Down
File renamed without changes.
3 changes: 0 additions & 3 deletions site/.gitignore

This file was deleted.

22 changes: 0 additions & 22 deletions site/.markdownlint.json

This file was deleted.

64 changes: 0 additions & 64 deletions site/Makefile

This file was deleted.

164 changes: 0 additions & 164 deletions site/README.md

This file was deleted.

Loading
Loading