fix stuff

frodesundby · frodesundby · commit ea28e3066928 · 2024-02-02T15:03:06.000+01:00
diff --git a/docs/explanation/observability/metrics.md b/docs/explanation/observability/metrics.md
@@ -10,7 +10,7 @@ We use Prometheus to fetch metric endpoints from your application (in Prometheus
 
 ??? info "Prometheus cluster configuration"
 To see the current configuration for a prometheus instance in your cluster, e.g. `scrape_interval`, go to
-`https://prometheus.<cluster>.@@TENANT@@.cloud.nais.io/config`
+`https://prometheus.<MY-ENV>.<<tenant()>>.cloud.nais.io/config`
 
 ```mermaid
 graph LR
diff --git a/docs/how-to-guides/NAIS CLI/install.md b/docs/how-to-guides/NAIS CLI/install.md
@@ -1,6 +1,6 @@
 # Install
 
-=== "macOS Installation"
+=== "macOS"
 
     1. Install [Homebrew](https://brew.sh/) (unless you already have it)
     2. Add the nais tap
@@ -12,7 +12,7 @@
      brew install nais
      ```
 
-=== "Ubuntu Installation"
+=== "Ubuntu"
 
     1. Add the nais PPA repo:
      ```
@@ -26,7 +26,7 @@
      sudo apt install nais
      ```
 
-=== "Windows Installation"
+=== "Windows"
 
     ### Install using Scoop
 
@@ -40,7 +40,7 @@
      scoop install nais-cli
      ```
 
-=== "Manual installation"
+=== "Manual"
 
     Download the archive for windows from [nais/cli](https://github.com/nais/cli/releases/latest) and unpack the tool to a directory on your `$PATH`.
     If you are unable to run nais after installing, check out our [troubleshooting guide](troubleshooting.md).
diff --git a/docs/how-to-guides/command-line-access.md b/docs/how-to-guides/command-line-access.md
@@ -39,7 +39,7 @@ A successful run will output how many clusters and where the kubeconfig file is
 ## 5. Verify access
 
 ```shell
-kubectl --context '<cluster name>' get ns
+kubectl --context '<MY-ENV>' get ns
 ```
 
 If you are unsure about which clusters are available, you can list them with:
diff --git a/docs/how-to-guides/create-team.md b/docs/how-to-guides/create-team.md
@@ -6,7 +6,7 @@ This how-to guide shows you how to create a NAIS team.
     Creating a team comes with quite a bit of overhead so this excersise should only be completeted if you are not part of a relevant team and just want find your bearings and get started.
 
 ## Prerequisites
-- [naisdevice installed](./naisdevice/install-tenant.md)
+- [naisdevice installed](./naisdevice/install-naisdevice.md)
 - A GitHub Account with access to your org. (eg. navikt) 
 - A Slack channel that can receive alerts concerning your apps and workloads
 
diff --git a/docs/how-to-guides/github-action.md b/docs/how-to-guides/github-action.md
@@ -4,9 +4,9 @@ This how-to guide shows you how to build and deploy your application using [Gith
 
 ## Prerequisites
 
-- You're part of a [NAIS team](../create-team.md)
+- You're part of a [NAIS team](./create-team.md)
 - A Github repository where the NAIS team has access
-- The repository contains a valid [nais.yaml](TODO)
+- The repository contains a valid [workload manifest](../explanation/workloads.md)
 
 ### 1. Authorize your Github repository for deployment
 
@@ -16,42 +16,42 @@ This how-to guide shows you how to build and deploy your application using [Gith
 
 ### 2. Create a Github workflow
 
-Create a new file in your repository under `.github/workflows/` called `main.yml` with the following content:
-
 !!! note 
     If you require a more advanced workflow, or already have one. Just copy the relevant parts from the example below.
 
-```yaml
-name: Build and deploy
-on:
-  push:
-    branches:
-      - main
-jobs:
-  build_and_deploy:
-    name: Build, push and deploy
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      - name: Push docker image to GAR
-        uses: nais/docker-build-push@v0
-        id: docker-build-push
-        with:
-          team: <MY-TEAM> # Replace
-          identity_provider: ${{ secrets.NAIS_WORKLOAD_IDENTITY_PROVIDER }} # Provided as Organization Secret
-          project_id: ${{ vars.NAIS_MANAGEMENT_PROJECT_ID }} # Provided as Organization Variable
-      - name: Deploy to NAIS
-        uses: nais/deploy/actions/deploy@v2
-        env:
-          CLUSTER: <MY-CLUSTER> # Replace
-          RESOURCE: nais.yaml #, topic.yaml, statefulset.yaml, etc.
-          VAR: image=${{ steps.docker-build-push.outputs.image }}
-```
+!!! note "./github/workflows/main.yml"
+
+    ```yaml hl_lines="19 25-26"
+    name: Build and deploy
+    on:
+      push:
+        branches:
+          - main
+    jobs:
+      build_and_deploy:
+        name: Build, push and deploy
+        runs-on: ubuntu-latest
+        permissions:
+          contents: read
+          id-token: write
+        steps:
+          - uses: actions/checkout@v4
+          - name: Push docker image to GAR
+            uses: nais/docker-build-push@v0
+            id: docker-build-push
+            with:
+              team: <MY-TEAM> # Replace
+              identity_provider: ${{ secrets.NAIS_WORKLOAD_IDENTITY_PROVIDER }} # Provided as Organization Secret
+              project_id: ${{ vars.NAIS_MANAGEMENT_PROJECT_ID }} # Provided as Organization Variable
+          - name: Deploy to NAIS
+            uses: nais/deploy/actions/deploy@v2
+            env:
+              CLUSTER: <MY-CLUSTER> # Replace
+              RESOURCE: .nais/app.yaml #, topic.yaml, statefulset.yaml, etc.
+              VAR: image=${{ steps.docker-build-push.outputs.image }}
+    ```
 
 This example workflow is a minimal example that builds, signs, and pushes your container image to the image registry.
-It then deploys the [nais.yaml](TODO), injecting the image tag from the previous step.
+It then deploys the [app.yaml](../reference/application-spec.md), injecting the image tag from the previous step.
 
 When this file is pushed to the `main` branch, the workflow will be triggered and you are all set.
diff --git a/docs/how-to-guides/leader-election.md b/docs/how-to-guides/leader-election.md
@@ -2,13 +2,13 @@
 
 This guide will show you how to enable leader election for your appliaction
 
-## 0. Enable leader election in [manifest](../reference/application-spec.md)
+## 0. Enable leader election in [manifest](../reference/application-spec.md#leaderelection)
 
 ???+ note ".nais/app.yaml"
 
-    ```yaml hl_lines="2-3"
+    ```yaml 
     spec:
-    leaderElection: true
+      leaderElection: true
     ```
 
 ## 1. Using leader election in your application
diff --git a/docs/how-to-guides/naisdevice/install-naisdevice.md b/docs/how-to-guides/naisdevice/install-naisdevice.md
@@ -2,7 +2,7 @@
 
 ## Device-specific installation steps
 
-=== "macOS Installation"
+=== "macOS"
 
     1. [Install Homebrew](https://brew.sh/) unless you already have it.
 
@@ -31,7 +31,7 @@
 
     1. If you need to connect to anything running in K8s cluster, remember to [update your kubeconfig](TODO: missing)
 
-=== "Windows Installation"
+=== "Windows"
 
     #### Install using Scoop
 
@@ -55,14 +55,14 @@
     1. If you need to connect to anything running in K8s cluster, remember to [update your kubeconfig](TODO: fix link)
     1. Start _naisdevice_ from the _Start menu_
 
-=== "Manual installation"
+=== "Manual"
 
     1. [Download and install naisdevice-tenant.exe](https://github.com/nais/device/releases/latest)
     (you will be asked for administrator access when you run the installer)
     1. If you need to connect to anything running in K8s cluster, remember to [update your kubeconfig](TODO:Fix link)
     1. Start _naisdevice_ from the _Start menu_
 
-=== "Ubuntu Installation"
+=== "Ubuntu"
 
     !!! warning
 
diff --git a/docs/how-to-guides/observability/alerts/create.md b/docs/how-to-guides/observability/alerts/create.md
@@ -8,7 +8,7 @@ This guide shows you how to create alerts for your application.
 
 You can define alerts by using Kubernetes resources (`PrometheusRule`), as well as directly in Grafana (GUI based).
 
-You will have a separate alertmanager for each environment available at `https://alertmanager.<ENVIRONMENT>.<<tenant()>>.cloud.nais.io/`
+You will have a separate alertmanager for each environment available at `https://alertmanager.<MY-ENV>.<<tenant()>>.cloud.nais.io/`
 
 ## 1. Create PrometheusRule
 
@@ -18,8 +18,7 @@ You can define alerts by creating a `PrometheusRule` resource in your teams name
 
 ???+ note ".nais/alert.yaml"
 
-    ```yaml
-    ---
+    ```yaml hl_lines="4-5 7 10 23"
     apiVersion: monitoring.coreos.com/v1
     kind: PrometheusRule
     metadata:
@@ -48,22 +47,22 @@ You can define alerts by creating a `PrometheusRule` resource in your teams name
 
 ## 2. Activate the alert
 === "Automatically"
-    Add the file to your application repository, alongside `nais.yaml` to deploy with [NAIS github action](../../cicd/github-action.md).
+    Add the file to your application repository, alongside `nais.yaml` to deploy with [NAIS github action](../../github-action.md).
 === "Manually"
     ```bash
     kubectl apply -f ./nais/alert.yaml
     ```
 
 ## 3. Verify your alert
-You can see the alerts in the Alertmanager at `https://alertmanager.<ENVIRONMENT>.<<tenant()>>.cloud.nais.io/` and the defined rules in Prometheus at `https://prometheus.<ENVIRONMENT>.<<tenant()>>.cloud.nais.io/rules`
+You can see the alerts in the Alertmanager at `https://alertmanager.<MY-ENV>.<<tenant()>>.cloud.nais.io/` and the defined rules in Prometheus at `https://prometheus.<MY-ENV>.<<tenant()>>.cloud.nais.io/rules`
 
 ## 4. Disable resolved (Optional)
 
 A message will be automatically sent when the alert is resolved. In some cases this message may be unnecessary and can be disabled by adding the label `send_resolved: "false"`:
 
 ```yaml
 labels:
-  namespace: <team namespace> # required
+  namespace: <MY-TEAM> # required
   severity: info
   send_resolved: "false"
 ```
diff --git a/docs/how-to-guides/observability/alerts/custom.md b/docs/how-to-guides/observability/alerts/custom.md
diff --git a/docs/how-to-guides/observability/metrics/expose.md b/docs/how-to-guides/observability/metrics/expose.md
diff --git a/docs/how-to-guides/persistence/bigquery/create.md b/docs/how-to-guides/persistence/bigquery/create.md
diff --git a/docs/how-to-guides/persistence/redis.md b/docs/how-to-guides/persistence/redis.md
