diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml index 2e06aad2bd..e3071df774 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -3,15 +3,15 @@ on: workflow_dispatch: inputs: environment: - description: 'Environment to deploy to' + description: "Environment to deploy to" required: true - default: 'preview' + default: "preview" type: choice options: - - preview - - dev - - staging - - prod + - preview + - dev + - staging + - prod pull_request: branches: - "*" diff --git a/docs/README.md b/docs/README.md index 5f9d31ab02..41b345b769 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ This directory contains all of the user documentation for NGINX Ingress Controller, as well as the requirements for building and publishing the documentation. -Documentation is written in Markdown, built using [Hugo](https://gohugo.io) with [nginx-hugo-theme](https://github.com/nginxinc/nginx-hugo-theme). Previews and deployments are handled by the [docs-actions](https://github.com/nginxinc/docs-actions?tab=readme-ov-file#docs-actions) workflow. +We write our documentation in Markdown. We build it with [Hugo](https://gohugo.io) and our custom [NGINX Hugo theme](https://github.com/nginxinc/nginx-hugo-theme). We set up previews and deployments using our [docs-actions](https://github.com/nginxinc/docs-actions?tab=readme-ov-file#docs-actions) workflow. ## Setup