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/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..92d14bad69 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}/site/content 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/ci.yml b/.github/workflows/ci.yml index d6f6d64a2e..3fc1fa54a2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -60,8 +60,8 @@ 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") - docs_files=$(git diff --name-only HEAD^ | grep "^docs/") + files=$(git diff --name-only HEAD^ | egrep -v "^site/" | egrep -v "^examples/" | egrep -v "^README.md") + docs_files=$(git diff --name-only HEAD^ | grep "^site/") if [ -z "$files" ]; then echo "docs_only=true" >> $GITHUB_OUTPUT else @@ -206,7 +206,7 @@ jobs: - name: Check if make docs builds if: ${{ needs.checks.outputs.some_docs == 'true' }} - run: cd docs && make docs-ci + run: cd site && make docs-ci unit-tests: name: Unit Tests 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/docs-build-push.yml b/.github/workflows/docs-build-push.yml index bca333c2ae..b328082a17 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -12,11 +12,16 @@ on: - dev - staging - prod + hugo_theme_override: + description: 'Override hugo theme (leave blank to use latest version)' + required: false + default: '' + type: string pull_request: branches: - "*" paths: - - "docs/**" + - "site/**" push: branches: - "release-3.7" @@ -34,9 +39,10 @@ jobs: production_url_path: "/nginx-ingress-controller" preview_url_path: "/previews/nginx-ingress-controller" docs_source_path: "public/nginx-ingress-controller" - docs_build_path: "./docs" + docs_build_path: "./site" doc_type: "hugo" environment: ${{ inputs.environment }} + force_hugo_theme_version: ${{inputs.hugo_theme_override}} auto_deploy_branch: "release-3.7" auto_deploy_env: "prod" secrets: 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/.gitignore b/.gitignore index 357c3597e3..d4235ebe69 100644 --- a/.gitignore +++ b/.gitignore @@ -50,12 +50,9 @@ default.pem hack/controller-gen-* # Ignore local docs dependencies -site/ venv/ -docs/public -docs/themes/f5-hugo -.netlify/ -docs/.netlify +site/public +site/themes/f5-hugo # trivy container scanning cache .trivycache/ diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index 750c3023c7..80de28bc89 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -10,7 +10,7 @@ config: # Define glob expressions to ignore ignores: - ".github/**" - - "docs/**" # Ignore docs folder for now + - "site/**" # Ignore docs folder for now # Fix any fixable errors fix: true 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) diff --git a/docs/go.sum b/docs/go.sum deleted file mode 100644 index 5dbffbf03f..0000000000 --- a/docs/go.sum +++ /dev/null @@ -1,2 +0,0 @@ -github.com/nginxinc/nginx-hugo-theme v0.41.19 h1:CyZOhU8q0p3nQ+ZTFRx7c/Dq9rxV1mShADIHz0vDoHo= -github.com/nginxinc/nginx-hugo-theme v0.41.19/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= diff --git a/docs/layouts/shortcodes/nic-helm-version.html b/docs/layouts/shortcodes/nic-helm-version.html deleted file mode 100644 index e21e727f96..0000000000 --- a/docs/layouts/shortcodes/nic-helm-version.html +++ /dev/null @@ -1 +0,0 @@ -1.4.0 \ No newline at end of file diff --git a/docs/layouts/shortcodes/nic-operator-version.html b/docs/layouts/shortcodes/nic-operator-version.html deleted file mode 100644 index 9183195ace..0000000000 --- a/docs/layouts/shortcodes/nic-operator-version.html +++ /dev/null @@ -1 +0,0 @@ -2.4.0 \ No newline at end of file diff --git a/docs/layouts/shortcodes/nic-version.html b/docs/layouts/shortcodes/nic-version.html deleted file mode 100644 index 240bba9069..0000000000 --- a/docs/layouts/shortcodes/nic-version.html +++ /dev/null @@ -1 +0,0 @@ -3.7.0 \ No newline at end of file diff --git a/docs/.hugo_build.lock b/site/.hugo_build.lock similarity index 100% rename from docs/.hugo_build.lock rename to site/.hugo_build.lock diff --git a/docs/.markdownlint.json b/site/.markdownlint.json similarity index 100% rename from docs/.markdownlint.json rename to site/.markdownlint.json diff --git a/docs/Makefile b/site/Makefile similarity index 100% rename from docs/Makefile rename to site/Makefile diff --git a/docs/README.md b/site/README.md similarity index 100% rename from docs/README.md rename to site/README.md diff --git a/docs/config/_default/config.toml b/site/config/_default/config.toml similarity index 100% rename from docs/config/_default/config.toml rename to site/config/_default/config.toml diff --git a/docs/config/development/config.toml b/site/config/development/config.toml similarity index 100% rename from docs/config/development/config.toml rename to site/config/development/config.toml diff --git a/docs/config/production/config.toml b/site/config/production/config.toml similarity index 100% rename from docs/config/production/config.toml rename to site/config/production/config.toml diff --git a/docs/config/staging/config.toml b/site/config/staging/config.toml similarity index 100% rename from docs/config/staging/config.toml rename to site/config/staging/config.toml diff --git a/docs/content/_index.md b/site/content/_index.md similarity index 100% rename from docs/content/_index.md rename to site/content/_index.md diff --git a/docs/content/community.md b/site/content/community.md similarity index 100% rename from docs/content/community.md rename to site/content/community.md diff --git a/docs/content/configuration/_index.md b/site/content/configuration/_index.md similarity index 100% rename from docs/content/configuration/_index.md rename to site/content/configuration/_index.md diff --git a/docs/content/configuration/configuration-examples.md b/site/content/configuration/configuration-examples.md similarity index 100% rename from docs/content/configuration/configuration-examples.md rename to site/content/configuration/configuration-examples.md diff --git a/docs/content/configuration/global-configuration/_index.md b/site/content/configuration/global-configuration/_index.md similarity index 100% rename from docs/content/configuration/global-configuration/_index.md rename to site/content/configuration/global-configuration/_index.md diff --git a/docs/content/configuration/global-configuration/command-line-arguments.md b/site/content/configuration/global-configuration/command-line-arguments.md similarity index 100% rename from docs/content/configuration/global-configuration/command-line-arguments.md rename to site/content/configuration/global-configuration/command-line-arguments.md diff --git a/docs/content/configuration/global-configuration/configmap-resource.md b/site/content/configuration/global-configuration/configmap-resource.md similarity index 100% rename from docs/content/configuration/global-configuration/configmap-resource.md rename to site/content/configuration/global-configuration/configmap-resource.md diff --git a/docs/content/configuration/global-configuration/custom-templates.md b/site/content/configuration/global-configuration/custom-templates.md similarity index 100% rename from docs/content/configuration/global-configuration/custom-templates.md rename to site/content/configuration/global-configuration/custom-templates.md diff --git a/docs/content/configuration/global-configuration/globalconfiguration-resource.md b/site/content/configuration/global-configuration/globalconfiguration-resource.md similarity index 100% rename from docs/content/configuration/global-configuration/globalconfiguration-resource.md rename to site/content/configuration/global-configuration/globalconfiguration-resource.md diff --git a/docs/content/configuration/global-configuration/reporting-resources-status.md b/site/content/configuration/global-configuration/reporting-resources-status.md similarity index 100% rename from docs/content/configuration/global-configuration/reporting-resources-status.md rename to site/content/configuration/global-configuration/reporting-resources-status.md diff --git a/docs/content/configuration/host-and-listener-collisions.md b/site/content/configuration/host-and-listener-collisions.md similarity index 100% rename from docs/content/configuration/host-and-listener-collisions.md rename to site/content/configuration/host-and-listener-collisions.md diff --git a/docs/content/configuration/ingress-resources/_index.md b/site/content/configuration/ingress-resources/_index.md similarity index 100% rename from docs/content/configuration/ingress-resources/_index.md rename to site/content/configuration/ingress-resources/_index.md diff --git a/docs/content/configuration/ingress-resources/advanced-configuration-with-annotations.md b/site/content/configuration/ingress-resources/advanced-configuration-with-annotations.md similarity index 100% rename from docs/content/configuration/ingress-resources/advanced-configuration-with-annotations.md rename to site/content/configuration/ingress-resources/advanced-configuration-with-annotations.md diff --git a/docs/content/configuration/ingress-resources/advanced-configuration-with-snippets.md b/site/content/configuration/ingress-resources/advanced-configuration-with-snippets.md similarity index 100% rename from docs/content/configuration/ingress-resources/advanced-configuration-with-snippets.md rename to site/content/configuration/ingress-resources/advanced-configuration-with-snippets.md diff --git a/docs/content/configuration/ingress-resources/basic-configuration.md b/site/content/configuration/ingress-resources/basic-configuration.md similarity index 100% rename from docs/content/configuration/ingress-resources/basic-configuration.md rename to site/content/configuration/ingress-resources/basic-configuration.md diff --git a/docs/content/configuration/ingress-resources/cross-namespace-configuration.md b/site/content/configuration/ingress-resources/cross-namespace-configuration.md similarity index 100% rename from docs/content/configuration/ingress-resources/cross-namespace-configuration.md rename to site/content/configuration/ingress-resources/cross-namespace-configuration.md diff --git a/docs/content/configuration/ingress-resources/custom-annotations.md b/site/content/configuration/ingress-resources/custom-annotations.md similarity index 100% rename from docs/content/configuration/ingress-resources/custom-annotations.md rename to site/content/configuration/ingress-resources/custom-annotations.md diff --git a/docs/content/configuration/policy-resource.md b/site/content/configuration/policy-resource.md similarity index 100% rename from docs/content/configuration/policy-resource.md rename to site/content/configuration/policy-resource.md diff --git a/docs/content/configuration/security.md b/site/content/configuration/security.md similarity index 100% rename from docs/content/configuration/security.md rename to site/content/configuration/security.md diff --git a/docs/content/configuration/transportserver-resource.md b/site/content/configuration/transportserver-resource.md similarity index 100% rename from docs/content/configuration/transportserver-resource.md rename to site/content/configuration/transportserver-resource.md diff --git a/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md b/site/content/configuration/virtualserver-and-virtualserverroute-resources.md similarity index 100% rename from docs/content/configuration/virtualserver-and-virtualserverroute-resources.md rename to site/content/configuration/virtualserver-and-virtualserverroute-resources.md diff --git a/docs/content/glossary.md b/site/content/glossary.md similarity index 100% rename from docs/content/glossary.md rename to site/content/glossary.md diff --git a/docs/content/includes/index.md b/site/content/includes/index.md similarity index 100% rename from docs/content/includes/index.md rename to site/content/includes/index.md diff --git a/docs/content/includes/installation/create-common-resources.md b/site/content/includes/installation/create-common-resources.md similarity index 100% rename from docs/content/includes/installation/create-common-resources.md rename to site/content/includes/installation/create-common-resources.md diff --git a/docs/content/includes/installation/create-custom-resources.md b/site/content/includes/installation/create-custom-resources.md similarity index 100% rename from docs/content/includes/installation/create-custom-resources.md rename to site/content/includes/installation/create-custom-resources.md diff --git a/docs/content/includes/installation/deploy-controller.md b/site/content/includes/installation/deploy-controller.md similarity index 100% rename from docs/content/includes/installation/deploy-controller.md rename to site/content/includes/installation/deploy-controller.md diff --git a/docs/content/includes/installation/jwt-password-note.md b/site/content/includes/installation/jwt-password-note.md similarity index 100% rename from docs/content/includes/installation/jwt-password-note.md rename to site/content/includes/installation/jwt-password-note.md diff --git a/docs/content/includes/installation/manifests/daemonset.md b/site/content/includes/installation/manifests/daemonset.md similarity index 100% rename from docs/content/includes/installation/manifests/daemonset.md rename to site/content/includes/installation/manifests/daemonset.md diff --git a/docs/content/includes/installation/manifests/deployment.md b/site/content/includes/installation/manifests/deployment.md similarity index 100% rename from docs/content/includes/installation/manifests/deployment.md rename to site/content/includes/installation/manifests/deployment.md diff --git a/docs/content/includes/installation/manifests/verify-pods-are-running.md b/site/content/includes/installation/manifests/verify-pods-are-running.md similarity index 100% rename from docs/content/includes/installation/manifests/verify-pods-are-running.md rename to site/content/includes/installation/manifests/verify-pods-are-running.md diff --git a/docs/content/includes/rbac/set-up-rbac.md b/site/content/includes/rbac/set-up-rbac.md similarity index 100% rename from docs/content/includes/rbac/set-up-rbac.md rename to site/content/includes/rbac/set-up-rbac.md diff --git a/docs/content/installation/_index.md b/site/content/installation/_index.md similarity index 100% rename from docs/content/installation/_index.md rename to site/content/installation/_index.md diff --git a/docs/content/installation/build-nginx-ingress-controller.md b/site/content/installation/build-nginx-ingress-controller.md similarity index 100% rename from docs/content/installation/build-nginx-ingress-controller.md rename to site/content/installation/build-nginx-ingress-controller.md diff --git a/docs/content/installation/ingress-nginx.md b/site/content/installation/ingress-nginx.md similarity index 100% rename from docs/content/installation/ingress-nginx.md rename to site/content/installation/ingress-nginx.md diff --git a/docs/content/installation/installing-nic/_index.md b/site/content/installation/installing-nic/_index.md similarity index 100% rename from docs/content/installation/installing-nic/_index.md rename to site/content/installation/installing-nic/_index.md diff --git a/docs/content/installation/installing-nic/installation-with-helm.md b/site/content/installation/installing-nic/installation-with-helm.md similarity index 100% rename from docs/content/installation/installing-nic/installation-with-helm.md rename to site/content/installation/installing-nic/installation-with-helm.md diff --git a/docs/content/installation/installing-nic/installation-with-manifests.md b/site/content/installation/installing-nic/installation-with-manifests.md similarity index 100% rename from docs/content/installation/installing-nic/installation-with-manifests.md rename to site/content/installation/installing-nic/installation-with-manifests.md diff --git a/docs/content/installation/installing-nic/installation-with-operator.md b/site/content/installation/installing-nic/installation-with-operator.md similarity index 100% rename from docs/content/installation/installing-nic/installation-with-operator.md rename to site/content/installation/installing-nic/installation-with-operator.md diff --git a/docs/content/installation/integrations/_index.md b/site/content/installation/integrations/_index.md similarity index 100% rename from docs/content/installation/integrations/_index.md rename to site/content/installation/integrations/_index.md diff --git a/docs/content/installation/integrations/app-protect-dos/_index.md b/site/content/installation/integrations/app-protect-dos/_index.md similarity index 100% rename from docs/content/installation/integrations/app-protect-dos/_index.md rename to site/content/installation/integrations/app-protect-dos/_index.md diff --git a/docs/content/installation/integrations/app-protect-dos/configuration.md b/site/content/installation/integrations/app-protect-dos/configuration.md similarity index 100% rename from docs/content/installation/integrations/app-protect-dos/configuration.md rename to site/content/installation/integrations/app-protect-dos/configuration.md diff --git a/docs/content/installation/integrations/app-protect-dos/dos-protected.md b/site/content/installation/integrations/app-protect-dos/dos-protected.md similarity index 100% rename from docs/content/installation/integrations/app-protect-dos/dos-protected.md rename to site/content/installation/integrations/app-protect-dos/dos-protected.md diff --git a/docs/content/installation/integrations/app-protect-dos/installation.md b/site/content/installation/integrations/app-protect-dos/installation.md similarity index 100% rename from docs/content/installation/integrations/app-protect-dos/installation.md rename to site/content/installation/integrations/app-protect-dos/installation.md diff --git a/docs/content/installation/integrations/app-protect-dos/troubleshoot-app-protect-dos.md b/site/content/installation/integrations/app-protect-dos/troubleshoot-app-protect-dos.md similarity index 100% rename from docs/content/installation/integrations/app-protect-dos/troubleshoot-app-protect-dos.md rename to site/content/installation/integrations/app-protect-dos/troubleshoot-app-protect-dos.md diff --git a/docs/content/installation/integrations/app-protect-waf-v5/_index.md b/site/content/installation/integrations/app-protect-waf-v5/_index.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf-v5/_index.md rename to site/content/installation/integrations/app-protect-waf-v5/_index.md diff --git a/docs/content/installation/integrations/app-protect-waf-v5/compile-waf-policies.md b/site/content/installation/integrations/app-protect-waf-v5/compile-waf-policies.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf-v5/compile-waf-policies.md rename to site/content/installation/integrations/app-protect-waf-v5/compile-waf-policies.md diff --git a/docs/content/installation/integrations/app-protect-waf-v5/configuration.md b/site/content/installation/integrations/app-protect-waf-v5/configuration.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf-v5/configuration.md rename to site/content/installation/integrations/app-protect-waf-v5/configuration.md diff --git a/docs/content/installation/integrations/app-protect-waf-v5/installation.md b/site/content/installation/integrations/app-protect-waf-v5/installation.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf-v5/installation.md rename to site/content/installation/integrations/app-protect-waf-v5/installation.md diff --git a/docs/content/installation/integrations/app-protect-waf/_index.md b/site/content/installation/integrations/app-protect-waf/_index.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf/_index.md rename to site/content/installation/integrations/app-protect-waf/_index.md diff --git a/docs/content/installation/integrations/app-protect-waf/configuration.md b/site/content/installation/integrations/app-protect-waf/configuration.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf/configuration.md rename to site/content/installation/integrations/app-protect-waf/configuration.md diff --git a/docs/content/installation/integrations/app-protect-waf/installation.md b/site/content/installation/integrations/app-protect-waf/installation.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf/installation.md rename to site/content/installation/integrations/app-protect-waf/installation.md diff --git a/docs/content/installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md b/site/content/installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md similarity index 100% rename from docs/content/installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md rename to site/content/installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md diff --git a/docs/content/installation/integrations/f5-ingresslink.md b/site/content/installation/integrations/f5-ingresslink.md similarity index 100% rename from docs/content/installation/integrations/f5-ingresslink.md rename to site/content/installation/integrations/f5-ingresslink.md diff --git a/docs/content/installation/integrations/opentracing.md b/site/content/installation/integrations/opentracing.md similarity index 100% rename from docs/content/installation/integrations/opentracing.md rename to site/content/installation/integrations/opentracing.md diff --git a/docs/content/installation/nic-images/_index.md b/site/content/installation/nic-images/_index.md similarity index 100% rename from docs/content/installation/nic-images/_index.md rename to site/content/installation/nic-images/_index.md diff --git a/docs/content/installation/nic-images/get-image-using-jwt.md b/site/content/installation/nic-images/get-image-using-jwt.md similarity index 100% rename from docs/content/installation/nic-images/get-image-using-jwt.md rename to site/content/installation/nic-images/get-image-using-jwt.md diff --git a/docs/content/installation/nic-images/get-registry-image.md b/site/content/installation/nic-images/get-registry-image.md similarity index 100% rename from docs/content/installation/nic-images/get-registry-image.md rename to site/content/installation/nic-images/get-registry-image.md diff --git a/docs/content/installation/nic-images/use-aws-image.md b/site/content/installation/nic-images/use-aws-image.md similarity index 100% rename from docs/content/installation/nic-images/use-aws-image.md rename to site/content/installation/nic-images/use-aws-image.md diff --git a/docs/content/installation/nic-images/use-gcp-image.md b/site/content/installation/nic-images/use-gcp-image.md similarity index 100% rename from docs/content/installation/nic-images/use-gcp-image.md rename to site/content/installation/nic-images/use-gcp-image.md diff --git a/docs/content/installation/run-multiple-ingress-controllers.md b/site/content/installation/run-multiple-ingress-controllers.md similarity index 100% rename from docs/content/installation/run-multiple-ingress-controllers.md rename to site/content/installation/run-multiple-ingress-controllers.md diff --git a/docs/content/logging-and-monitoring/_index.md b/site/content/logging-and-monitoring/_index.md similarity index 100% rename from docs/content/logging-and-monitoring/_index.md rename to site/content/logging-and-monitoring/_index.md diff --git a/docs/content/logging-and-monitoring/logging.md b/site/content/logging-and-monitoring/logging.md similarity index 100% rename from docs/content/logging-and-monitoring/logging.md rename to site/content/logging-and-monitoring/logging.md diff --git a/docs/content/logging-and-monitoring/prometheus.md b/site/content/logging-and-monitoring/prometheus.md similarity index 100% rename from docs/content/logging-and-monitoring/prometheus.md rename to site/content/logging-and-monitoring/prometheus.md diff --git a/docs/content/logging-and-monitoring/service-insight.md b/site/content/logging-and-monitoring/service-insight.md similarity index 100% rename from docs/content/logging-and-monitoring/service-insight.md rename to site/content/logging-and-monitoring/service-insight.md diff --git a/docs/content/logging-and-monitoring/status-page.md b/site/content/logging-and-monitoring/status-page.md similarity index 100% rename from docs/content/logging-and-monitoring/status-page.md rename to site/content/logging-and-monitoring/status-page.md diff --git a/docs/content/overview/_index.md b/site/content/overview/_index.md similarity index 100% rename from docs/content/overview/_index.md rename to site/content/overview/_index.md diff --git a/docs/content/overview/about.md b/site/content/overview/about.md similarity index 100% rename from docs/content/overview/about.md rename to site/content/overview/about.md diff --git a/docs/content/overview/controller-comparison.md b/site/content/overview/controller-comparison.md similarity index 100% rename from docs/content/overview/controller-comparison.md rename to site/content/overview/controller-comparison.md diff --git a/docs/content/overview/design.md b/site/content/overview/design.md similarity index 100% rename from docs/content/overview/design.md rename to site/content/overview/design.md diff --git a/docs/content/overview/nginx-plus.md b/site/content/overview/nginx-plus.md similarity index 100% rename from docs/content/overview/nginx-plus.md rename to site/content/overview/nginx-plus.md diff --git a/docs/content/overview/product-telemetry.md b/site/content/overview/product-telemetry.md similarity index 100% rename from docs/content/overview/product-telemetry.md rename to site/content/overview/product-telemetry.md diff --git a/docs/content/releases.md b/site/content/releases.md similarity index 100% rename from docs/content/releases.md rename to site/content/releases.md diff --git a/docs/content/technical-specifications.md b/site/content/technical-specifications.md similarity index 100% rename from docs/content/technical-specifications.md rename to site/content/technical-specifications.md diff --git a/docs/content/troubleshooting/_index.md b/site/content/troubleshooting/_index.md similarity index 100% rename from docs/content/troubleshooting/_index.md rename to site/content/troubleshooting/_index.md diff --git a/docs/content/troubleshooting/troubleshoot-common.md b/site/content/troubleshooting/troubleshoot-common.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-common.md rename to site/content/troubleshooting/troubleshoot-common.md diff --git a/docs/content/troubleshooting/troubleshoot-configmap-policy.md b/site/content/troubleshooting/troubleshoot-configmap-policy.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-configmap-policy.md rename to site/content/troubleshooting/troubleshoot-configmap-policy.md diff --git a/docs/content/troubleshooting/troubleshoot-ingress.md b/site/content/troubleshooting/troubleshoot-ingress.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-ingress.md rename to site/content/troubleshooting/troubleshoot-ingress.md diff --git a/docs/content/troubleshooting/troubleshoot-support.md b/site/content/troubleshooting/troubleshoot-support.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-support.md rename to site/content/troubleshooting/troubleshoot-support.md diff --git a/docs/content/troubleshooting/troubleshoot-transportserver.md b/site/content/troubleshooting/troubleshoot-transportserver.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-transportserver.md rename to site/content/troubleshooting/troubleshoot-transportserver.md diff --git a/docs/content/troubleshooting/troubleshoot-virtualserver.md b/site/content/troubleshooting/troubleshoot-virtualserver.md similarity index 100% rename from docs/content/troubleshooting/troubleshoot-virtualserver.md rename to site/content/troubleshooting/troubleshoot-virtualserver.md diff --git a/docs/content/tutorials/_index.md b/site/content/tutorials/_index.md similarity index 100% rename from docs/content/tutorials/_index.md rename to site/content/tutorials/_index.md diff --git a/docs/content/tutorials/custom-listen-ports.md b/site/content/tutorials/custom-listen-ports.md similarity index 100% rename from docs/content/tutorials/custom-listen-ports.md rename to site/content/tutorials/custom-listen-ports.md diff --git a/docs/content/tutorials/ingress-path-regex-annotation.md b/site/content/tutorials/ingress-path-regex-annotation.md similarity index 100% rename from docs/content/tutorials/ingress-path-regex-annotation.md rename to site/content/tutorials/ingress-path-regex-annotation.md diff --git a/docs/content/tutorials/nginx-dynamic-module.md b/site/content/tutorials/nginx-dynamic-module.md similarity index 100% rename from docs/content/tutorials/nginx-dynamic-module.md rename to site/content/tutorials/nginx-dynamic-module.md diff --git a/docs/content/tutorials/nginx-ingress-istio.md b/site/content/tutorials/nginx-ingress-istio.md similarity index 100% rename from docs/content/tutorials/nginx-ingress-istio.md rename to site/content/tutorials/nginx-ingress-istio.md diff --git a/docs/content/tutorials/nginx-ingress-linkerd.md b/site/content/tutorials/nginx-ingress-linkerd.md similarity index 100% rename from docs/content/tutorials/nginx-ingress-linkerd.md rename to site/content/tutorials/nginx-ingress-linkerd.md diff --git a/docs/content/tutorials/nginx-ingress-osm.md b/site/content/tutorials/nginx-ingress-osm.md similarity index 100% rename from docs/content/tutorials/nginx-ingress-osm.md rename to site/content/tutorials/nginx-ingress-osm.md diff --git a/docs/content/tutorials/oidc-custom-configuration.md b/site/content/tutorials/oidc-custom-configuration.md similarity index 100% rename from docs/content/tutorials/oidc-custom-configuration.md rename to site/content/tutorials/oidc-custom-configuration.md diff --git a/docs/content/tutorials/security-monitoring.md b/site/content/tutorials/security-monitoring.md similarity index 100% rename from docs/content/tutorials/security-monitoring.md rename to site/content/tutorials/security-monitoring.md diff --git a/docs/content/tutorials/virtual-server-with-custom-listener-ports.md b/site/content/tutorials/virtual-server-with-custom-listener-ports.md similarity index 100% rename from docs/content/tutorials/virtual-server-with-custom-listener-ports.md rename to site/content/tutorials/virtual-server-with-custom-listener-ports.md diff --git a/docs/content/usage-reporting.md b/site/content/usage-reporting.md similarity index 100% rename from docs/content/usage-reporting.md rename to site/content/usage-reporting.md diff --git a/docs/developer/README.md b/site/developer/README.md similarity index 100% rename from docs/developer/README.md rename to site/developer/README.md diff --git a/docs/developer/debugging.md b/site/developer/debugging.md similarity index 100% rename from docs/developer/debugging.md rename to site/developer/debugging.md diff --git a/docs/developer/telemetry-schema-generation.md b/site/developer/telemetry-schema-generation.md similarity index 100% rename from docs/developer/telemetry-schema-generation.md rename to site/developer/telemetry-schema-generation.md diff --git a/docs/go.mod b/site/go.mod similarity index 50% rename from docs/go.mod rename to site/go.mod index 0b0ccbcaa7..a88d5f6260 100644 --- a/docs/go.mod +++ b/site/go.mod @@ -2,4 +2,4 @@ module github.com/nginxinc/kubernetes-ingress/docs go 1.23.0 -require github.com/nginxinc/nginx-hugo-theme v0.41.19 // indirect +require github.com/nginxinc/nginx-hugo-theme v0.41.20 // indirect diff --git a/site/go.sum b/site/go.sum new file mode 100644 index 0000000000..18ea623847 --- /dev/null +++ b/site/go.sum @@ -0,0 +1,2 @@ +github.com/nginxinc/nginx-hugo-theme v0.41.20 h1:6BJGRGdHW17OpkC4qbcHARo9TRrJPFrALBjFltwedf8= +github.com/nginxinc/nginx-hugo-theme v0.41.20/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= diff --git a/docs/hugo-entrypoint.sh b/site/hugo-entrypoint.sh similarity index 100% rename from docs/hugo-entrypoint.sh rename to site/hugo-entrypoint.sh diff --git a/docs/layouts/shortcodes/call-out.html b/site/layouts/shortcodes/call-out.html similarity index 100% rename from docs/layouts/shortcodes/call-out.html rename to site/layouts/shortcodes/call-out.html diff --git a/docs/layouts/shortcodes/custom-styles.html b/site/layouts/shortcodes/custom-styles.html similarity index 100% rename from docs/layouts/shortcodes/custom-styles.html rename to site/layouts/shortcodes/custom-styles.html diff --git a/site/layouts/shortcodes/nic-helm-version.html b/site/layouts/shortcodes/nic-helm-version.html new file mode 100644 index 0000000000..88c5fb891d --- /dev/null +++ b/site/layouts/shortcodes/nic-helm-version.html @@ -0,0 +1 @@ +1.4.0 diff --git a/site/layouts/shortcodes/nic-operator-version.html b/site/layouts/shortcodes/nic-operator-version.html new file mode 100644 index 0000000000..197c4d5c2d --- /dev/null +++ b/site/layouts/shortcodes/nic-operator-version.html @@ -0,0 +1 @@ +2.4.0 diff --git a/site/layouts/shortcodes/nic-version.html b/site/layouts/shortcodes/nic-version.html new file mode 100644 index 0000000000..7c69a55dbb --- /dev/null +++ b/site/layouts/shortcodes/nic-version.html @@ -0,0 +1 @@ +3.7.0 diff --git a/docs/md-linkcheck-config.json b/site/md-linkcheck-config.json similarity index 100% rename from docs/md-linkcheck-config.json rename to site/md-linkcheck-config.json diff --git a/docs/static/img/control-loop.png b/site/static/img/control-loop.png similarity index 100% rename from docs/static/img/control-loop.png rename to site/static/img/control-loop.png diff --git a/docs/static/img/controller-sync.png b/site/static/img/controller-sync.png similarity index 100% rename from docs/static/img/controller-sync.png rename to site/static/img/controller-sync.png diff --git a/docs/static/img/ecr-pull-instructions.png b/site/static/img/ecr-pull-instructions.png similarity index 100% rename from docs/static/img/ecr-pull-instructions.png rename to site/static/img/ecr-pull-instructions.png diff --git a/docs/static/img/gke-create-cluster.png b/site/static/img/gke-create-cluster.png similarity index 100% rename from docs/static/img/gke-create-cluster.png rename to site/static/img/gke-create-cluster.png diff --git a/docs/static/img/gke-creating-cluster.png b/site/static/img/gke-creating-cluster.png similarity index 100% rename from docs/static/img/gke-creating-cluster.png rename to site/static/img/gke-creating-cluster.png diff --git a/docs/static/img/gke-existing-cluster.png b/site/static/img/gke-existing-cluster.png similarity index 100% rename from docs/static/img/gke-existing-cluster.png rename to site/static/img/gke-existing-cluster.png diff --git a/docs/static/img/gke-ingress-controller-application.png b/site/static/img/gke-ingress-controller-application.png similarity index 100% rename from docs/static/img/gke-ingress-controller-application.png rename to site/static/img/gke-ingress-controller-application.png diff --git a/docs/static/img/gke-install-to-new-cluster.png b/site/static/img/gke-install-to-new-cluster.png similarity index 100% rename from docs/static/img/gke-install-to-new-cluster.png rename to site/static/img/gke-install-to-new-cluster.png diff --git a/docs/static/img/ic-high-level.png b/site/static/img/ic-high-level.png similarity index 100% rename from docs/static/img/ic-high-level.png rename to site/static/img/ic-high-level.png diff --git a/docs/static/img/ic-pod.png b/site/static/img/ic-pod.png similarity index 100% rename from docs/static/img/ic-pod.png rename to site/static/img/ic-pod.png diff --git a/docs/static/img/ic-process-components.png b/site/static/img/ic-process-components.png similarity index 100% rename from docs/static/img/ic-process-components.png rename to site/static/img/ic-process-components.png diff --git a/docs/static/img/ic-process.png b/site/static/img/ic-process.png similarity index 100% rename from docs/static/img/ic-process.png rename to site/static/img/ic-process.png diff --git a/docs/static/img/nginx-envoy.png b/site/static/img/nginx-envoy.png similarity index 100% rename from docs/static/img/nginx-envoy.png rename to site/static/img/nginx-envoy.png diff --git a/docs/static/img/nginx_istio_small.png b/site/static/img/nginx_istio_small.png similarity index 100% rename from docs/static/img/nginx_istio_small.png rename to site/static/img/nginx_istio_small.png diff --git a/docs/static/img/nginx_plain.png b/site/static/img/nginx_plain.png similarity index 100% rename from docs/static/img/nginx_plain.png rename to site/static/img/nginx_plain.png