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 <johnny@horvi.no>

---------

Co-authored-by: Johnny Horvi <johnny@horvi.no>

.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"

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:

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

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:

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

doc/templates/example/application.md

@@ -1,3 +1,7 @@
+---
+tags: [application, reference]
+---
+
 # NAIS Application example YAML
 
 <!--

doc/templates/example/naisjob.md

@@ -1,3 +1,7 @@
+---
+tags: [job, reference]
+---
+
 # NAIS Job example YAML
 
 <!--

doc/templates/example/topic.md

@@ -1,3 +1,7 @@
+---
+tags: [kafka, reference]
+---
+
 # NAIS Topic example YAML
 
 <!--

doc/templates/reference/application.md

@@ -1,3 +1,7 @@
+---
+tags: [application, reference]
+---
+
 # NAIS Application reference
 
 <!--

doc/templates/reference/naisjob.md

@@ -1,3 +1,7 @@
+---
+tags: [job, reference]
+---
+
 # NAIS Job reference
 
 <!--

doc/templates/reference/topic.md

@@ -1,3 +1,7 @@
+---
+tags: [kafka, reference]
+---
+
 # NAIS Topic reference
 
 <!--

pkg/apis/nais.io/v1/digdirator_types.go

@@ -136,7 +136,6 @@ type ConsumedScope struct {
 
 type ExposedScope struct {
 	// If Enabled the configured scope is available to be used and consumed by organizations granted access.
-	// +nais:doc:Link="https://doc.nais.io/naisjob/reference/#maskinportenscopesexposesconsumers"
 	// +kubebuilder:validation:Required
 	Enabled bool `json:"enabled"`
 	// The actual subscope combined with `Product`.

pkg/apis/nais.io/v1/naiserator_types.go

@@ -132,7 +132,6 @@ type GCP struct {
 	// +nais:doc:Availability=GCP
 	SqlInstances []CloudSqlInstance `json:"sqlInstances,omitempty"`
 	// List of _additional_ permissions that should be granted to your application for accessing external GCP resources that have not been provisioned through NAIS.
-	// +nais:doc:Link="https://doc.nais.io/nais-application/permissions-in-gcp/"
 	// +nais:doc:Availability=GCP
 	Permissions []CloudIAMPermission `json:"permissions,omitempty"`
 }
@@ -291,7 +290,7 @@ type Kafka struct {
 	Pool string `json:"pool"`
 
 	// Allow this app to use kafka streams
-	// +nais:doc:Link="https://doc.nais.io/persistence/kafka/application/#using-kafka-streams-with-internal-topics"
+	// +nais:doc:Link="https://doc.nais.io/persistence/kafka/how-to/internal"
 	// +nais:doc:Availability=GCP
 	// +nais:doc:Default="false"
 	Streams bool `json:"streams,omitempty"`
@@ -369,7 +368,7 @@ type Replicas struct {
 	// +nais:doc:Default="false"
 	DisableAutoScaling bool `json:"disableAutoScaling,omitempty"`
 	// ScalingStrategy configures how automatic scaling is performed.
-	// +nais:doc:link:https://doc.nais.io/nais-application/automatic-scaling/
+	// +nais:doc:link:https://doc.nais.io/workloads/application/reference/automatic-scaling/
 	ScalingStrategy *ScalingStrategy `json:"scalingStrategy,omitempty"`
 }
 
@@ -498,7 +497,7 @@ type CloudSqlDatabase struct {
 	// +kubebuilder:validation:Required
 	Name string `json:"name"`
 	// 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).
 	EnvVarPrefix string `json:"envVarPrefix,omitempty"`
 	// Add extra users for database access. These users need to be manually given access to database tables.
 	Users []CloudSqlDatabaseUser `json:"users,omitempty"`
@@ -669,15 +668,15 @@ func (envVars EnvVars) ToKubernetes() []corev1.EnvVar {
 type Wonderwall struct {
 	// Automatically redirect the user to login for all proxied GET requests.
 	// +nais:doc:Default="false"
-	// +nais:doc:Link="https://doc.nais.io/explanation/auth/wonderwall/#12-autologin"
+	// +nais:doc:Link="https://doc.nais.io/security/auth/wonderwall/#12-autologin"
 	AutoLogin bool `json:"autoLogin,omitempty"`
 	// Comma separated list of absolute paths to ignore when auto-login is enabled.
-	// +nais:doc:Link="https://doc.nais.io/explanation/auth/wonderwall/#12-autologin"
+	// +nais:doc:Link="https://doc.nais.io/security/auth/wonderwall/#12-autologin"
 	AutoLoginIgnorePaths []WonderwallIgnorePaths `json:"autoLoginIgnorePaths,omitempty"`
 	// Enable the sidecar.
 	Enabled bool `json:"enabled"`
 	// Resource requirements for the sidecar container.
-	// +nais:doc:Link="https://doc.nais.io/explanation/auth/wonderwall/#4-resource-requirements"
+	// +nais:doc:Link="https://doc.nais.io/security/auth/wonderwall/#4-resource-requirements"
 	Resources *ResourceRequirements `json:"resources,omitempty"`
 }
 
@@ -688,7 +687,7 @@ type FrontendGeneratedConfig struct {
 	// If specified, a Javascript file with application specific frontend configuration variables
 	// will be generated and mounted into the pod file system at the specified path.
 	// You can import this file directly from your Javascript application.
-	// +nais:doc:Link="https://doc.nais.io/explanation/observability/frontend/#auto-configuration"
+	// +nais:doc:Link="https://doc.nais.io/observability/frontend/#auto-configuration"
 	MountPath string `json:"mountPath"`
 }
 
@@ -716,7 +715,7 @@ type Logging struct {
 	Enabled bool `json:"enabled,omitempty"`
 
 	// Log destinations for where to forward application logs for persistent storage. Leave empty to use default destinations.
-	// +nais:doc:Link="https://doc.nais.io/explanation/observability/logging/#log-destinations"
+	// +nais:doc:Link="https://doc.nais.io/observability/logging/#log-destinations"
 	Destinations []LogDestination `json:"destinations,omitempty"`
 }
 
@@ -728,11 +727,11 @@ type Observability struct {
 	// Enable application performance monitoring with traces collected using OpenTelemetry and the OTLP exporter.
 	// +nais:doc:Availability="GCP"
 	// +nais:doc:Experimental=true
-	// +nais:doc:Link="https://doc.nais.io/explanation/observability/tracing/"
+	// +nais:doc:Link="https://doc.nais.io/observability/tracing/"
 	Tracing *Tracing `json:"tracing,omitempty"`
 
 	// Configure logging for your application.
-	// +nais:doc:Link="https://doc.nais.io/explanation/observability/logging/"
+	// +nais:doc:Link="https://doc.nais.io/observability/logging/"
 	Logging *Logging `json:"logging,omitempty"`
 
 	// Enable auto-instrumenting your application using the OpenTelemetry Agent.

pkg/apis/nais.io/v1/naisjob_types.go

@@ -43,7 +43,7 @@ type NaisjobSpec struct {
 	// By default, no traffic is allowed between naisjobs inside the cluster.
 	// Configure access policies to explicitly allow communication between naisjobs.
 	// This is also used for granting inbound access in the context of Azure AD and TokenX clients.
-	// +nais:doc:Link="https://doc.nais.io/explanation/zero-trust/"
+	// +nais:doc:Link="https://doc.nais.io/workloads/explanations/zero-trust/"
 	AccessPolicy *AccessPolicy `json:"accessPolicy,omitempty"`
 
 	// Once a Naisjob reaches activeDeadlineSeconds, all of its running Pods are terminated and the Naisjob status will become type: Failed with reason: DeadlineExceeded.
@@ -128,7 +128,7 @@ type NaisjobSpec struct {
 	Logtransform string `json:"logtransform,omitempty"`
 
 	// 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.
 	Maskinporten *Maskinporten `json:"maskinporten,omitempty"`
 
 	// To get your own OpenSearch instance head over to the IaC-repo to provision each instance.
@@ -144,7 +144,7 @@ type NaisjobSpec struct {
 	// PreStopHook is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc.
 	// The handler is not called if the container crashes or exits by itself.
 	// The reason for termination is passed to the handler.
-	// +nais:doc:Link="https://doc.nais.io/reference/good-practices/#handles-termination-gracefully";"https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
+	// +nais:doc:Link="https://doc.nais.io/workloads/explanations/good-practices/#handles-termination-gracefully";"https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
 	PreStopHook *PreStopHook `json:"preStopHook,omitempty"`
 
 	// Sometimes, Naisjobs are temporarily unable to serve traffic. For example, an Naisjob might need
@@ -157,7 +157,7 @@ type NaisjobSpec struct {
 
 	// List of redis instances this job needs credentials for.
 	// Must be owned by same team.
-	// +nais:doc:Link="https://doc.nais.io/explanation/persistence/redis/"
+	// +nais:doc:Link="https://doc.nais.io/persistence/redis/"
 	Redis []Redis `json:"redis,omitempty"`
 
 	// RestartPolicy describes how the container should be restarted. Only one of the following restart policies may be specified.
@@ -168,7 +168,7 @@ type NaisjobSpec struct {
 
 	// When Containers have [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) specified,
 	// the Kubernetes scheduler can make better decisions about which nodes to place pods on.
-	// +nais:doc:Link="https://doc.nais.io/reference/good-practices/#set-reasonable-resource-requests-and-limits"
+	// +nais:doc:Link="https://doc.nais.io/workloads/explanations/good-practices/#set-reasonable-resource-requests-and-limits"
 	Resources *ResourceRequirements `json:"resources,omitempty"`
 
 	// The [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running the Naisjob.
@@ -206,7 +206,7 @@ type NaisjobSpec struct {
 	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
 
 	// Configuration options related to application observability.
-	// +nais:doc:Link="https://doc.nais.io/explanation/observability/"
+	// +nais:doc:Link="https://doc.nais.io/observability/"
 	Observability *Observability `json:"observability,omitempty"`
 
 	// Provides secrets management, identity-based access, and encrypting application data for auditing of secrets