Skip to content

Commit

Permalink
add handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz
Browse files Browse the repository at this point in the history
handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/README.md
handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/main.yaml
handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/values.schema.json
  • Loading branch information
catalogbot committed Dec 17, 2024
1 parent 6101f60 commit 98926ce
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 1 deletion.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.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.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/values.schema.json
chartApiVersion: v1
chartFile: handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz
dateCreated: '2024-12-17T12:36:18.202720Z'
digest: 4b53d582033d0cdda52ac1f6c542ef97b2bd1b593cdd621929cb5e2a7a6467a9
home: https://github.com/giantswarm/handbook
icon: https://s.giantswarm.io/app-icons/handbook/1/dark.svg
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
}
}
}
20 changes: 19 additions & 1 deletion index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11837,6 +11837,24 @@ entries:
urls:
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.96.tgz
version: 0.13.96
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.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.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz-meta/values.schema.json
apiVersion: v1
appVersion: main
created: "2024-12-17T12:36:20.636433528Z"
description: A Helm chart for out handbook
digest: 4b53d582033d0cdda52ac1f6c542ef97b2bd1b593cdd621929cb5e2a7a6467a9
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.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0.tgz
version: 0.13.96-d17cf2f7823b42df84abe19568c89d31e3c59ab0
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.95.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/handbook-0.13.95.tgz-meta/README.md
Expand Down Expand Up @@ -12917,4 +12935,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-17T12:21:13.283377615Z"
generated: "2024-12-17T12:36:20.63517213Z"

0 comments on commit 98926ce

Please sign in to comment.