From f515c7fe78e6befa08c6f699d42c965d130f8881 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 1 Oct 2024 17:25:44 +0100 Subject: [PATCH] Update remaining docs path references, fix links --- .fossa.yml | 2 +- .github/dependabot.yml | 2 +- .github/labeler.yml | 2 +- .github/scripts/release-notes-update.sh | 2 +- .github/scripts/release-version-update.sh | 8 ++++---- .github/scripts/variables.sh | 2 +- .github/workflows/codeql-analysis.yml | 2 +- .github/workflows/dependabot-hugo.yml | 4 ++-- .github/workflows/fossa.yml | 2 +- .github/workflows/mend.yml | 2 +- .pre-commit-config.yaml | 4 ++-- CODEOWNERS | 2 +- CONTRIBUTING.md | 6 +++--- README.md | 4 ++-- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.fossa.yml b/.fossa.yml index 442038aed1..7d51bf2a7c 100644 --- a/.fossa.yml +++ b/.fossa.yml @@ -4,4 +4,4 @@ targets: - type: setuptools paths: exclude: - - docs + - site diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a657dbe4a1..55c11a6ac1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -56,6 +56,6 @@ updates: - "patch" - package-ecosystem: gomod - directory: /docs + directory: /site schedule: interval: weekly diff --git a/.github/labeler.yml b/.github/labeler.yml index fb698cc48f..810417ddb8 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -32,7 +32,7 @@ tests: - all-globs-to-all-files: ['!tests/requirements.txt', '!perf-tests/requirements.txt'] documentation: - - head-branch: ['^docs/', '^doc/'] + - head-branch: ['^site/'] - changed-files: - any-glob-to-any-file: '**/*.md' diff --git a/.github/scripts/release-notes-update.sh b/.github/scripts/release-notes-update.sh index 47adb43b90..2ae80ebb00 100755 --- a/.github/scripts/release-notes-update.sh +++ b/.github/scripts/release-notes-update.sh @@ -6,7 +6,7 @@ ROOTDIR=$(git rev-parse --show-toplevel || echo ".") TMPDIR=/tmp DEBUG=${DEBUG:-"false"} -DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/docs/content +DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/site/content usage() { echo "Usage: $0 " diff --git a/.github/scripts/release-version-update.sh b/.github/scripts/release-version-update.sh index 002c1e3c22..8d80303517 100755 --- a/.github/scripts/release-version-update.sh +++ b/.github/scripts/release-version-update.sh @@ -9,7 +9,7 @@ DEPLOYMENT_PATH="${ROOTDIR}/deployments" EXAMPLES_PATH="${ROOTDIR}/examples" DEBUG=${DEBUG:-"false"} -DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/docs/content +DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/docs/site FILES_TO_UPDATE_IC_VERSION=( "${ROOTDIR}/.github/data/version.txt" "${ROOTDIR}/README.md" @@ -121,9 +121,9 @@ for i in "${FILE_TO_UPDATE_HELM_CHART_VERSION[@]}"; do done # update docs with new versions -echo -n "${new_ic_version}" > ./docs/layouts/shortcodes/nic-version.html -echo -n "${new_helm_chart_version}" > ./docs/layouts/shortcodes/nic-helm-version.html -echo -n "${new_operator_version}" > ./docs/layouts/shortcodes/nic-operator-version.html +echo -n "${new_ic_version}" > ./site/layouts/shortcodes/nic-version.html +echo -n "${new_helm_chart_version}" > ./site/layouts/shortcodes/nic-helm-version.html +echo -n "${new_operator_version}" > ./site/layouts/shortcodes/nic-operator-version.html # update examples with new versions example_files=$(find "${EXAMPLES_PATH}" -type f -name "*.md") diff --git a/.github/scripts/variables.sh b/.github/scripts/variables.sh index f4a1d60850..80494ba0db 100755 --- a/.github/scripts/variables.sh +++ b/.github/scripts/variables.sh @@ -18,7 +18,7 @@ get_docker_md5() { } get_go_code_md5() { - find . -type f \( -name "*.go" -o -name go.mod -o -name go.sum -o -name "*.tmpl" -o -name "version.txt" \) -not -path "./docs*" -exec md5sum {} + | LC_ALL=C sort | md5sum | awk '{ print $1 }' + find . -type f \( -name "*.go" -o -name go.mod -o -name go.sum -o -name "*.tmpl" -o -name "version.txt" \) -not -path "./site*" -exec md5sum {} + | LC_ALL=C sort | md5sum | awk '{ print $1 }' } get_tests_md5() { diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index c908b9b259..ecbbb38ed5 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -35,7 +35,7 @@ jobs: - name: Filter only docs changes id: docs run: | - files=$(git diff --name-only HEAD^ | egrep -v "^docs/" | egrep -v "^examples/" | egrep -v "^README.md") + files=$(git diff --name-only HEAD^ | egrep -v "^site/" | egrep -v "^examples/" | egrep -v "^README.md") if [ -z "$files" ]; then echo "docs_only=true" >> $GITHUB_OUTPUT else diff --git a/.github/workflows/dependabot-hugo.yml b/.github/workflows/dependabot-hugo.yml index a56dbc2309..77e51e26dd 100644 --- a/.github/workflows/dependabot-hugo.yml +++ b/.github/workflows/dependabot-hugo.yml @@ -3,7 +3,7 @@ name: Run hugo commands on Dependabot PRs on: pull_request: paths: - - "docs/go.mod" + - "site/go.mod" merge_group: permissions: @@ -38,7 +38,7 @@ jobs: - name: Run build if: ${{ steps.dependabot-metadata.outputs.package-ecosystem == 'go_modules' && contains(steps.dependabot-metadata.outputs.dependency-names, 'hugo') }} - working-directory: docs + working-directory: site run: | hugo mod tidy hugo mod verify diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml index e6d7207fd9..10d9c90e4b 100644 --- a/.github/workflows/fossa.yml +++ b/.github/workflows/fossa.yml @@ -5,7 +5,7 @@ on: branches: - main paths-ignore: - - "docs/**" + - "site/**" - "examples/**" - "**.md" diff --git a/.github/workflows/mend.yml b/.github/workflows/mend.yml index 43eda4ee33..3b25472f10 100644 --- a/.github/workflows/mend.yml +++ b/.github/workflows/mend.yml @@ -5,7 +5,7 @@ on: branches: - main paths-ignore: - - docs/** + - site/** - examples/** workflow_dispatch: inputs: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 049608b381..22ea498ae6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ # See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks -exclude: (^docs/_vendor/|.*pb2.*) +exclude: (^site/_vendor/|.*pb2.*) repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 @@ -8,7 +8,7 @@ repos: - id: trailing-whitespace exclude: '(\.md|\.snap|\.avdl)$' - id: end-of-file-fixer - exclude: docs/layouts/shortcodes/nic-.*.html + exclude: site/layouts/shortcodes/nic-.*.html - id: check-yaml args: [--allow-multiple-documents] exclude: ^(charts/nginx-ingress/templates) diff --git a/CODEOWNERS b/CODEOWNERS index 758ac92a95..c9779a164e 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,2 +1,2 @@ * @nginxinc/kic -/docs/ @nginxinc/kic @nginxinc/nginx-docs +/site/ @nginxinc/kic @nginxinc/nginx-docs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1421d95385..aa6882d465 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,15 +28,15 @@ Please reserve GitHub issues for feature requests and bugs rather than general q ## Getting Started -Follow our [Installation Guide](https://github.com/nginxinc/kubernetes-ingress/blob/main/docs/content/installation) to +Follow our [Installation Guide](https://docs.nginx.com/nginx-ingress-controller/installation/) to get NGINX Ingress Controller up and running. -Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs) and +Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/site) and [configuration](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples) examples ### Project Structure -- This Ingress Controller is written in Go and supports both the open source NGINX software and NGINX Plus. +- NGINX Ingress Controller is written in Go and supports both the open source NGINX software and NGINX Plus. - The project follows a standard Go project layout - The main code is found at `cmd/nginx-ingress/` - The internal code is found at `internal/` diff --git a/README.md b/README.md index 4f634f09de..59c6079326 100644 --- a/README.md +++ b/README.md @@ -140,8 +140,8 @@ your links to the correct versions: | Version | Description | Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples | | ------- | ----------- | --------------- | -------------------- | ---------------------------------------| -------------------------- | -| Latest stable release | For production use | Use the 3.7.0 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 3.7.0 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.0/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | -| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). | +| Latest stable release | For production use | Use the 3.7.0 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-ingress-controller-image/). | Use the 3.7.0 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.0/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | +| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/site/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). | ## SBOM (Software Bill of Materials)