Render docs using Svelte with ds-svelte (Aksel) theme #810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

thokra-nav wants to merge 73 commits into nais:main from thokra-nav:ds-svelte

.github/dependabot.yml

This file was deleted.

.github/workflows/dependabot-auto-merge.yml

This file was deleted.

.github/workflows/deploy-pages.yml

-Original file line number
+Diff line change
@@ -0,0 +1,52 @@
+    name: Deploy to GitHub Pages
+    on:
+      push:
+        branches:
+          - ds-svelte
+    jobs:
+      build_site:
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v6
+            with:
+              fetch-depth: 0 # Fetch all history for accurate git timestamps
+          - uses: jdx/mise-action@v3
+          - name: Install dependencies
+            working-directory: ./svdoc
+            run: bun i
+          - name: build
+            working-directory: ./svdoc
+            env:
+              BASE_PATH: "/${{ github.event.repository.name }}"
+              TENANT: "nav"
+            run: |
+              bun run build
+          - name: Upload Artifacts
+            uses: actions/upload-pages-artifact@v4
+            with:
+              # this should match the `pages` option in your adapter-static options
+              path: "svdoc/build/"
+      deploy:
+        needs: build_site
+        runs-on: ubuntu-latest
+        permissions:
+          pages: write
+          id-token: write
+        environment:
+          name: github-pages
+          url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+          - name: Deploy
+            id: deployment
+            uses: actions/deploy-pages@v4

.github/workflows/main.yml

This file was deleted.

.tool-versions

Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		poetry 2.0.0
		bun 1.3.3

.vscode/settings.json

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    {
+      "editor.formatOnSave": false
+    }

docs/README.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,12 +5,6 @@ hide: @@
       - footer
       - toc
     ---
-    <!-- This hides the edit button on the start page -->
-    <style>
-      .md-content__button {
-        display: none;
-      }
-    </style>
     # :wave: **Welcome to the Nais developer documentation!**
@@ Expand Down @@

docs/auth/README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -40,9 +40,9 @@ See the different scenarios below to identify which service(s) you need for your
  
    Depending on who your users are, you can use the following services to log them in:

    :person_standing: Log in _employees_ :octicons-arrow-right-24: [Entra ID]

    :standing_person: Log in _employees_ :octicons-arrow-right-24: [Entra ID]

    :person_standing: Log in _citizens_ :octicons-arrow-right-24: [ID-porten]

    :standing_person: Log in _citizens_ :octicons-arrow-right-24: [ID-porten]

    ## Validating inbound requests

    @@ -63,9 +63,9 @@ graph TD
  
    The graph above can also be described as:

    :material-server::person_standing: Validate requests from _internal_ application acting on behalf of _employee_ :octicons-arrow-right-24: [Entra ID]

    :material-server::standing_person: Validate requests from _internal_ application acting on behalf of _employee_ :octicons-arrow-right-24: [Entra ID]

    :material-server::person_standing: Validate requests from _internal_ application acting on behalf of _citizen_:octicons-arrow-right-24: [TokenX]

    :material-server::standing_person: Validate requests from _internal_ application acting on behalf of _citizen_:octicons-arrow-right-24: [TokenX]

    :material-server: Validate requests from _internal_ application :octicons-arrow-right-24: [Entra ID]

    @@ -87,9 +87,9 @@ graph TD
  
    The graph above can also be described as:

    :material-server::person_standing: Make requests to _internal_ API on behalf of _employee_ :octicons-arrow-right-24: [Entra ID]

    :material-server::standing_person: Make requests to _internal_ API on behalf of _employee_ :octicons-arrow-right-24: [Entra ID]

    :material-server::person_standing: Make requests to _internal_ API on behalf of _citizen_ :octicons-arrow-right-24: [TokenX]

    :material-server::standing_person: Make requests to _internal_ API on behalf of _citizen_ :octicons-arrow-right-24: [TokenX]

    :material-server: Make requests to _internal_ API :octicons-arrow-right-24: [Entra ID]

docs/auth/how-to/login.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -62,7 +62,7 @@ Before you begin, ensure that you have: @@
         :   The client secret for your application.
 . Optionally, add additional environment variables to the secret to configure the login proxy further.
-    See the [Wonderwall configuration reference :octicons-link-external-16:](https://github.com/nais/wonderwall/blob/master/docs/configuration.md) for all available options.
+    See the [Wonderwall configuration reference](https://github.com/nais/wonderwall/blob/master/docs/configuration.md) for all available options.
     ## Configure your application
@@ Expand Down @@

docs/explanations/under-the-hood.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -10,9 +10,9 @@ In this explanation, we will go through some of the underlying technologies we u
  
    ### Runtime implementation

    Each _environment_ is its own [Kubernetes :octicons-link-external-16:](https://kubernetes.io) cluster using [Google Kubernetes Engine (GKE) :octicons-link-external-16:](https://cloud.google.com/kubernetes-engine?hl=en).

    Each _environment_ is its own [Kubernetes](https://kubernetes.io) cluster using [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine?hl=en).

    Inside each environment, every team has their own [namespace :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).

    Inside each environment, every team has their own [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).

    A namespace can contain one or more [workloads](../workloads/README.md).

    Only members of the team have access to the namespace and its resources.

    @@ -33,13 +33,13 @@ In the example above, the team has an application and a job running in the `dev`
  
    All workloads are deployed in a team namespace.

    Every workload is isolated from _all_ other workloads with [Kubernetes network policies :octicons-link-external-16:](https://kubernetes.io/docs/concepts/services-networking/network-policies/).

    Every workload is isolated from _all_ other workloads with [Kubernetes network policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/).

    Access is denied by default, unless [explicitly allowed](../workloads/explanations/zero-trust.md).

    ## Google Cloud Platform (GCP) resources

    Each team has a dedicated [GCP project :octicons-link-external-16:](https://cloud.google.com/resource-manager/docs/creating-managing-projects) for _each_ environment.

    Each team has a dedicated [GCP project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) for _each_ environment.

    When your workload requests resources e.g. a bucket, it will be provisioned in the team's project for the matching environment.

docs/operate/cli/how-to/install.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -8,47 +8,46 @@ tags: [command-line, how-to]
  
        1. Install [Homebrew](https://brew.sh/) (unless you already have it)

        2. Add the nais tap

        ```bash

        brew tap nais/tap

        ```

    		```bash

    		brew tap nais/tap

    		```

        3. Install the nais-cli

         ```bash

         brew install nais

         ```

    		```bash

    		brew install nais

    		```

    === "Ubuntu"

        !!! tip

            The PPA repo is shared between nais-cli and [naisdevice](../../naisdevice/README.md), so the first step may be unnecessary.

        1. Add the nais PPA repo:

         ```

         NAIS_GPG_KEY="/etc/apt/keyrings/nav_nais_gar.asc"

         curl -sfSL "https://europe-north1-apt.pkg.dev/doc/repo-signing-key.gpg" | sudo dd of="$NAIS_GPG_KEY"

         echo "deb [arch=amd64 signed-by=$NAIS_GPG_KEY] https://europe-north1-apt.pkg.dev/projects/nais-io nais-ppa main" | sudo tee /etc/apt/sources.list.d/nav_nais_gar.list

         sudo apt update

         ```

    		```

    		NAIS_GPG_KEY="/etc/apt/keyrings/nav_nais_gar.asc"

    		curl -sfSL "https://europe-north1-apt.pkg.dev/doc/repo-signing-key.gpg" | sudo dd of="$NAIS_GPG_KEY"

    		echo "deb [arch=amd64 signed-by=$NAIS_GPG_KEY] https://europe-north1-apt.pkg.dev/projects/nais-io nais-ppa main" | sudo tee /etc/apt/sources.list.d/nav_nais_gar.list

    		sudo apt update

    		```

        2. Install the nais package:

         ```

         sudo apt install nais

         ```

    		```

    		sudo apt install nais

    		```

    === "Windows"

        ### Install using Scoop

        1. Install [Scoop](https://scoop.sh) unless you already have it.

        2. Add the nais bucket

         ```powershell

        scoop bucket add nais https://github.com/nais/scoop-bucket

         ```

    		```

    		scoop bucket add nais https://github.com/nais/scoop-bucket

    		```

        3. Install nais-cli

         ```powershell

         scoop install nais-cli

         ```

    		```

    		scoop install nais-cli

    		```

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

docs/persistence/opensearch/how-to/create.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ## Steps
-. Open [Nais Console :octicons-link-external-16:](https://console.<<tenant()>>.cloud.nais.io) in your browser
+. Open [Nais Console](https://console.<<tenant()>>.cloud.nais.io) in your browser
 . Select your team
 . Select **OpenSearch** in the sidebar menu
 . Click the **Create OpenSearch** button
@@ Expand Down @@

docs/persistence/opensearch/how-to/upgrade-major-version.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ### 2. Upgrade the OpenSearch instance
-. Open [Nais Console :octicons-link-external-16:](https://console.<<tenant()>>.cloud.nais.io) in your browser
+. Open [Nais Console](https://console.<<tenant()>>.cloud.nais.io) in your browser
 . Select your team
 . Select **OpenSearch** in the sidebar menu
 . Select the OpenSearch instance you want to upgrade
@@ Expand Down @@

docs/persistence/valkey/how-to/create.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ## Steps
-. Open [Nais Console :octicons-link-external-16:](https://console.<<tenant()>>.cloud.nais.io) in your browser
+. Open [Nais Console](https://console.<<tenant()>>.cloud.nais.io) in your browser
 . Select your team
 . Select **Valkey** in the sidebar menu
 . Click the **Create Valkey** button
@@ Expand Down @@

docs/services/secrets/README.md

-Original file line number
+Diff line change
@@ Expand Up @@
     There are two types of secrets on the Nais platform:
     <div class="grid cards" markdown>
     -   :construction_worker: **Platform-provided secrets**
         ---
@@ Expand All / @@ -22,6 +23,7 @@ There are two types of secrets on the Nais platform: @@
     </div>
     <div class="grid cards" markdown>
     - :technologist: **User-defined secrets**
         ---
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Render docs using Svelte with ds-svelte (Aksel) theme #810

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Render docs using Svelte with ds-svelte (Aksel) theme #810

Are you sure you want to change the base?

Uh oh!

Render docs using Svelte with ds-svelte (Aksel) theme #810

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!