Skip to content

Update guidance and tooling for documentation #1431

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 17 commits into from
Jan 16, 2024
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
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,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/`.

## Contributing

Expand Down Expand Up @@ -93,6 +94,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.

## Contributor License Agreement

Expand Down
165 changes: 0 additions & 165 deletions docs/developer/documentation.md

This file was deleted.

26 changes: 11 additions & 15 deletions site/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifeq (, $(shell ${HUGO} version 2> /dev/null))
ifeq (, $(shell docker version 2> /dev/null))
$(error Docker and Hugo are not installed. Hugo (<0.91) or Docker are required to build the local preview.)
else
HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} hugo --bind 0.0.0.0 -p 1313
HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} hugo
endif
endif

Expand Down Expand Up @@ -43,7 +43,6 @@ else
endif
endif


.PHONY: all all-staging all-dev all-local clean hugo-mod build-production build-staging build-dev docs-drafts docs deploy-preview

all: hugo-mod build-production
Expand All @@ -54,28 +53,25 @@ all-dev: hugo-mod build-dev

all-local: clean hugo-mod build-production

# Removes the public directory generated by the `hugo` command
docs:
${HUGO}

clean:
if [[ -d ${PWD}/public ]] ; then rm -rf ${PWD}/public && echo "Removed public directory" ; else echo "Did not find a public directory to remove" ; fi

watch:
${HUGO} --bind 0.0.0.0 -p 1313 server --disableFastRender

docs-drafts:
${HUGO} server -D --disableFastRender

docs-local: clean
${HUGO}

docs:
${HUGO} server --disableFastRender

lint-markdown:
${MARKDOWNLINT} -c .markdownlint.yaml -- content
watch-drafts:
${HUGO} --bind 0.0.0.0 -p 1313 server -D --disableFastRender

link-check:
${MARKDOWNLINKCHECK} $(shell find content -name '*.md')

lint-markdown:
${MARKDOWNLINT} -c .markdownlint.yaml -- content

## commands for use in Netlify CI
# Commands used by Netlify CI
hugo-mod:
hugo mod get $(THEME_MODULE)@v$(THEME_VERSION)

Expand Down
Loading