From 674c94bce1772c0b5a9a12ec2b54f8f57528859d Mon Sep 17 00:00:00 2001 From: Trong Huu Nguyen Date: Wed, 15 May 2024 11:06:58 +0200 Subject: [PATCH] doc: fix links in preparation for new docs (#223) * docgen: add tags to template, update paths for outputs * fix links to docs in spec Co-authored-by: Johnny Horvi --------- Co-authored-by: Johnny Horvi --- .github/workflows/main.yml | 12 ++++----- charts/templates/nais.io_applications.yaml | 8 +++--- charts/templates/nais.io_naisjobs.yaml | 4 +-- config/crd/bases/nais.io_applications.yaml | 8 +++--- config/crd/bases/nais.io_naisjobs.yaml | 4 +-- doc/templates/example/application.md | 4 +++ doc/templates/example/naisjob.md | 4 +++ doc/templates/example/topic.md | 4 +++ doc/templates/reference/application.md | 4 +++ doc/templates/reference/naisjob.md | 4 +++ doc/templates/reference/topic.md | 4 +++ pkg/apis/nais.io/v1/digdirator_types.go | 1 - pkg/apis/nais.io/v1/naiserator_types.go | 21 +++++++-------- pkg/apis/nais.io/v1/naisjob_types.go | 12 ++++----- .../nais.io/v1alpha1/application_types.go | 26 +++++++++---------- 15 files changed, 71 insertions(+), 49 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 59ff3ecc..5f8d9070 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -47,12 +47,12 @@ jobs: - name: Commit documentation to nais/doc run: | cd naisdoc - cp -v ../liberator/doc/output/application/reference.md docs/reference/application-spec.md - cp -v ../liberator/doc/output/application/example.md docs/reference/application-example.md - cp -v ../liberator/doc/output/naisjob/reference.md docs/reference/naisjob-spec.md - cp -v ../liberator/doc/output/naisjob/example.md docs/reference/naisjob-example.md - cp -v ../liberator/doc/output/topic/reference.md docs/reference/kafka-topic-spec.md - cp -v ../liberator/doc/output/topic/example.md docs/reference/kafka-topic-example.md + cp -v ../liberator/doc/output/application/reference.md docs/workloads/application/reference/application-spec.md + cp -v ../liberator/doc/output/application/example.md docs/workloads/application/reference/application-example.md + cp -v ../liberator/doc/output/naisjob/reference.md docs/workloads/jobs/reference/naisjob-spec.md + cp -v ../liberator/doc/output/naisjob/example.md docs/workloads/jobs/reference/naisjob-example.md + cp -v ../liberator/doc/output/topic/reference.md docs/persistence/kafka/reference/kafka-topic-spec.md + cp -v ../liberator/doc/output/topic/example.md docs/persistence/kafka/reference/kafka-topic-example.md git config user.name "$GITHUB_ACTOR" git config user.email "$GITHUB_ACTOR@users.noreply.github.com" diff --git a/charts/templates/nais.io_applications.yaml b/charts/templates/nais.io_applications.yaml index 88a12e07..f2cf882c 100644 --- a/charts/templates/nais.io_applications.yaml +++ b/charts/templates/nais.io_applications.yaml @@ -586,7 +586,7 @@ spec: envVarPrefix: description: |- Prefix to add to environment variables made available for database connection. - If switching to `EnvVarPrefix` you need to [reset database credentials](https://docs.nais.io/persistence/postgres/#reset-database-credentials). + If switching to `EnvVarPrefix` you need to [reset database credentials](https://doc.nais.io/persistence/postgres/#reset-database-credentials). type: string name: description: |- @@ -739,7 +739,7 @@ spec: idporten: description: |- Configures ID-porten authentication for this application. - See [ID-porten](https://doc.nais.io/explanation/auth/idporten/) for more details. + See [ID-porten](https://doc.nais.io/security/auth/idporten/) for more details. properties: enabled: description: Enable ID-porten authentication. Requires `.spec.idporten.sidecar.enabled=true`. @@ -919,7 +919,7 @@ spec: maskinporten: description: |- Configures a Maskinporten client for this application. - See [Maskinporten](https://doc.nais.io/explanation/auth/maskinporten/) for more details. + See [Maskinporten](https://doc.nais.io/security/auth/maskinporten/) for more details. properties: enabled: description: If enabled, provisions and configures a Maskinporten @@ -1151,7 +1151,7 @@ spec: type: string prometheus: description: |- - Prometheus is used to [scrape metrics from the pod](https://doc.nais.io/explanation/observability/metrics/). + Prometheus is used to [scrape metrics from the pod](https://doc.nais.io/observability/metrics/). Use this configuration to override the default values. properties: enabled: diff --git a/charts/templates/nais.io_naisjobs.yaml b/charts/templates/nais.io_naisjobs.yaml index f2f73183..dd66edfc 100644 --- a/charts/templates/nais.io_naisjobs.yaml +++ b/charts/templates/nais.io_naisjobs.yaml @@ -546,7 +546,7 @@ spec: envVarPrefix: description: |- Prefix to add to environment variables made available for database connection. - If switching to `EnvVarPrefix` you need to [reset database credentials](https://docs.nais.io/persistence/postgres/#reset-database-credentials). + If switching to `EnvVarPrefix` you need to [reset database credentials](https://doc.nais.io/persistence/postgres/#reset-database-credentials). type: string name: description: |- @@ -785,7 +785,7 @@ spec: maskinporten: description: |- Configures a Maskinporten client for this Naisjob. - See [Maskinporten](https://doc.nais.io/explanation/auth/maskinporten/) for more details. + See [Maskinporten](https://doc.nais.io/security/auth/maskinporten/) for more details. properties: enabled: description: If enabled, provisions and configures a Maskinporten diff --git a/config/crd/bases/nais.io_applications.yaml b/config/crd/bases/nais.io_applications.yaml index 88a12e07..f2cf882c 100644 --- a/config/crd/bases/nais.io_applications.yaml +++ b/config/crd/bases/nais.io_applications.yaml @@ -586,7 +586,7 @@ spec: envVarPrefix: description: |- Prefix to add to environment variables made available for database connection. - If switching to `EnvVarPrefix` you need to [reset database credentials](https://docs.nais.io/persistence/postgres/#reset-database-credentials). + If switching to `EnvVarPrefix` you need to [reset database credentials](https://doc.nais.io/persistence/postgres/#reset-database-credentials). type: string name: description: |- @@ -739,7 +739,7 @@ spec: idporten: description: |- Configures ID-porten authentication for this application. - See [ID-porten](https://doc.nais.io/explanation/auth/idporten/) for more details. + See [ID-porten](https://doc.nais.io/security/auth/idporten/) for more details. properties: enabled: description: Enable ID-porten authentication. Requires `.spec.idporten.sidecar.enabled=true`. @@ -919,7 +919,7 @@ spec: maskinporten: description: |- Configures a Maskinporten client for this application. - See [Maskinporten](https://doc.nais.io/explanation/auth/maskinporten/) for more details. + See [Maskinporten](https://doc.nais.io/security/auth/maskinporten/) for more details. properties: enabled: description: If enabled, provisions and configures a Maskinporten @@ -1151,7 +1151,7 @@ spec: type: string prometheus: description: |- - Prometheus is used to [scrape metrics from the pod](https://doc.nais.io/explanation/observability/metrics/). + Prometheus is used to [scrape metrics from the pod](https://doc.nais.io/observability/metrics/). Use this configuration to override the default values. properties: enabled: diff --git a/config/crd/bases/nais.io_naisjobs.yaml b/config/crd/bases/nais.io_naisjobs.yaml index f2f73183..dd66edfc 100644 --- a/config/crd/bases/nais.io_naisjobs.yaml +++ b/config/crd/bases/nais.io_naisjobs.yaml @@ -546,7 +546,7 @@ spec: envVarPrefix: description: |- Prefix to add to environment variables made available for database connection. - If switching to `EnvVarPrefix` you need to [reset database credentials](https://docs.nais.io/persistence/postgres/#reset-database-credentials). + If switching to `EnvVarPrefix` you need to [reset database credentials](https://doc.nais.io/persistence/postgres/#reset-database-credentials). type: string name: description: |- @@ -785,7 +785,7 @@ spec: maskinporten: description: |- Configures a Maskinporten client for this Naisjob. - See [Maskinporten](https://doc.nais.io/explanation/auth/maskinporten/) for more details. + See [Maskinporten](https://doc.nais.io/security/auth/maskinporten/) for more details. properties: enabled: description: If enabled, provisions and configures a Maskinporten diff --git a/doc/templates/example/application.md b/doc/templates/example/application.md index ae13945e..b2ecb111 100644 --- a/doc/templates/example/application.md +++ b/doc/templates/example/application.md @@ -1,3 +1,7 @@ +--- +tags: [application, reference] +--- + # NAIS Application example YAML