add handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz

handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/README.md handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/main.yaml handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/values.schema.json
giantswarm · Dec 12, 2024 · d8ae1ff · d8ae1ff
1 parent be37e18
commit d8ae1ff
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 1 deletion.
diff --git a/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz b/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz
diff --git a/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/README.md b/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/README.md
@@ -0,0 +1,30 @@
+# Handbook
+
+This is the repository for our public [handbook](https://handbook.giantswarm.io/).
+
+For purely internal information we have our [intranet](https://intranet.giantswarm.io).
+
+## Repository Overview
+
+The `content` folder of this repository is served using the static site generator [HUGO](https://gohugo.io/) docs page.
+It is set up with the [Google docsy](https://github.com/google/docsy) theme and served at [https://handbook.giantswarm.io/](https://handbook.giantswarm.io/).
+
+## Development
+
+1. Create a `.env` file with the following content (replace the values with your own):
+    ```
+    ORIGINS=localhost:8081
+    OAUTH_CLIENT_ID=23456789abcdef123456
+    OAUTH_CLIENT_SECRET=abcdef1234567890124567890abcdef123456789
+    GIT_HOSTNAME=
+    ```
+2. You can then easily test and render any changes to the handbook with:
+    ```sh
+    docker-compose build --pull
+    docker-compose up
+    ```
+    The locally rendered site should then be accessible via `http://localhost:8081`.
+
+Or for a simplified setup, run `hugo server`.
+
+Auto-generated content needs to be rendered manually (eg. `make rfcs`), as it's normally updated through a GitHub action.
diff --git a/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/main.yaml b/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/main.yaml
@@ -0,0 +1,11 @@
+annotations:
+  application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/main.yaml
+  application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/README.md
+  application.giantswarm.io/team: up
+  application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/values.schema.json
+chartApiVersion: v1
+chartFile: handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz
+dateCreated: '2024-12-12T17:22:19.904460Z'
+digest: ea1e27d86ceda29513ced102c3456266b9ffbb8f5dcf2896e2ee076dbc311b1c
+home: https://github.com/giantswarm/handbook
+icon: https://s.giantswarm.io/app-icons/handbook/1/dark.svg
diff --git a/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/values.schema.json b/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/values.schema.json
@@ -0,0 +1,34 @@
+{
+    "$schema": "http://json-schema.org/schema#",
+    "type": "object",
+    "properties": {
+        "staticJsCmsHugoStandaloneVersion": {
+            "type": "string"
+        },
+        "secrets": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "data": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "key": {
+                                    "type": "string"
+                                },
+                                "value": {
+                                    "type": "string"
+                                }
+                            }
+                        }
+                    },
+                    "name": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/index.yaml b/index.yaml
@@ -9778,6 +9778,24 @@ entries:
     - https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/giantswarmio-nginx-app-0.6.3-04a1a88d37ddea8886bc2d0d7c7df4622838f379.tgz
     version: 0.6.3-04a1a88d37ddea8886bc2d0d7c7df4622838f379
   handbook:
+  - annotations:
+      application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/main.yaml
+      application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/README.md
+      application.giantswarm.io/team: up
+      application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz-meta/values.schema.json
+    apiVersion: v1
+    appVersion: main
+    created: "2024-12-12T17:22:21.964986174Z"
+    description: A Helm chart for out handbook
+    digest: ea1e27d86ceda29513ced102c3456266b9ffbb8f5dcf2896e2ee076dbc311b1c
+    home: https://github.com/giantswarm/handbook
+    icon: https://s.giantswarm.io/app-icons/handbook/1/dark.svg
+    name: handbook
+    sources:
+    - https://github.com/giantswarm/handbook
+    urls:
+    - https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833.tgz
+    version: 0.13.93-7821efe50ab8a3efd43277bbdaea987eac71b833
   - annotations:
       application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.92-fce6afe2045bc4f5625e59259398d6aa673af095.tgz-meta/main.yaml
       application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.92-fce6afe2045bc4f5625e59259398d6aa673af095.tgz-meta/README.md
@@ -10732,4 +10750,4 @@ entries:
     urls:
     - https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/web-assets-app-0.12.2-794550fdee2ed66a0cd7ef5c7ba802a6626db441.tgz
     version: 0.12.2-794550fdee2ed66a0cd7ef5c7ba802a6626db441
-generated: "2024-12-12T17:15:50.892042052Z"
+generated: "2024-12-12T17:22:21.963641269Z"