-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
intranet-0.2.477.tgz-meta/README.md intranet-0.2.477.tgz-meta/main.yaml intranet-0.2.477.tgz-meta/values.schema.json
- Loading branch information
1 parent
5cc1323
commit bc99b34
Showing
5 changed files
with
131 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Giant Swarm Issues and Resources | ||
|
|
||
| This repository exists exclusively for internal issues as well as documentation and communication. | ||
|
|
||
| ## 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://intranet.giantswarm.io/](https://intranet.giantswarm.io/). | ||
|
|
||
| For more information on how to add / edit content in Intranet as well as information about the deployment and testing locally checkout [Intranet FAQ](https://github.com/giantswarm/giantswarm/blob/main/content/docs/intranet-faq/_index.md) page. | ||
| The full documentation about Docsy is available at https://www.docsy.dev/docs/. | ||
|
|
||
| **Note:** Project boards can be found on the [organization level](https://github.com/orgs/giantswarm/projects). | ||
|
|
||
| ## Notes for Mac M1/M2 users | ||
|
|
||
| The docker build takes an unusually long time to perform the Hugo build step, likely due to platform emulation, and can take about 10 minutes before the website is running when performing `docker-compose up` for the first time. Subsequent runs can still take about 5 minutes to build the pages. | ||
|
|
||
| It is recommended to run the site using `Hugo` on your local machine, rather than Docker. (See below) | ||
|
|
||
| ## Running Locally | ||
|
|
||
| If you want to run the intranet locally using Hugo on your local machine you must first fetch the git submodules that contain the theme: | ||
|
|
||
| ``` | ||
| git submodule update --init --recursive | ||
| npm install ; cd themes/docsy ; npm install ; cd ../.. | ||
| ``` | ||
|
|
||
| Once the submodules are updated you may run `./run-dev-server-with-merge.sh` and navigate to `http://localhost:1313` in your web browser. | ||
|
|
||
| ## Running locally with docker-compose or podman-compose | ||
|
|
||
| This project can be run locally to view the site just like it would be on the server. The Intranet Editor will still try to access the GitHub API, so using it in a local setup may be of limited use for now. | ||
|
|
||
| 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. Run `docker-compose up` or `podman-compose up` (if you have podman installed) | ||
| 3. Navigate to `http://localhost:8081` in your web browser |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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-catalog/intranet-0.2.477.tgz-meta/main.yaml | ||
| application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-catalog/intranet-0.2.477.tgz-meta/README.md | ||
| application.giantswarm.io/team: up | ||
| application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-catalog/intranet-0.2.477.tgz-meta/values.schema.json | ||
| chartApiVersion: v1 | ||
| chartFile: intranet-0.2.477.tgz | ||
| dateCreated: '2025-02-06T10:06:00.586977' | ||
| digest: 00b9ddc222ac93443851f7d765f416e582377961e4df7939835bb3b8ea9b767b | ||
| home: https://github.com/giantswarm/giantswarm | ||
| icon: https://s.giantswarm.io/app-icons/intranet/1/dark.svg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/schema#", | ||
| "type": "object", | ||
| "properties": { | ||
| "cookieDomain": { | ||
| "type": "string" | ||
| }, | ||
| "staticJsCmsHugoStandaloneVersion": { | ||
| "type": "string" | ||
| }, | ||
| "githubUsers": { | ||
| "type": "string" | ||
| }, | ||
| "global": { | ||
| "type": "object", | ||
| "properties": { | ||
| "podSecurityStandards": { | ||
| "type": "object", | ||
| "properties": { | ||
| "enforced": { | ||
| "type": "boolean" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "hostName": { | ||
| "description": "Host name to enable ingress for", | ||
| "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" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |