Skip to content

Commit be37e18

Browse files
catalogbotcatalogbot
committed
add docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz
docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/README.md docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/main.yaml docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/values.schema.json
1 parent be0fe4e commit be37e18

File tree

5 files changed

+124
-1
lines changed

5 files changed

+124
-1
lines changed

‎docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz

2.23 KB
Binary file not shown.

‎docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Giant Swarm user documentation
2+
3+
This is the main documentation repository for the documentation available at https://docs.giantswarm.io.
4+
5+
## Contributing
6+
7+
**We welcome any contributions on content to this repository in the form of pull requests!**
8+
9+
Please review the [Contribution guidelines](CONTRIBUTING.md) for guidelines on suggesting changes and getting them published this repository.
10+
11+
If you are an employee of Giant Swarm you can get more information per [intranet page](https://intranet.giantswarm.io/docs/product/docs/) with info on style and other pre-requisites.
12+
13+
While making changes, please use
14+
15+
```sh
16+
make dev
17+
```
18+
19+
to render the results. This serves the web content on http://localhost:1313/ by default. Please check if your changes display correctly before opening a pull request.
20+
21+
### Content linting
22+
23+
When writing docs content, the linter can help you a great deal to keep the content consistent and clean. You can run the linter with:
24+
25+
```sh
26+
make lint-prose
27+
```
28+
29+
When editing content in Microsoft Visual Studio Code, you can also use the [vale-vscode](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) extension to see errors and editing suggestions while you write.
30+
31+
To keep third party style rules up-to-date, please run `make lint-prose-update` and commit the resulting changes.
32+
33+
## Search
34+
35+
The search functionality works since last Nov 2023 using a third-party system called [Inkeep](https://inkeep.com/) which makes use of Artificial Intelligence to index all the content of our docs and serve good results. Also, it allows to have a conversational interface to get a faster response in our wide documentation hub.
36+
37+
In [the internal portal](https://portal.inkeep.com/) we've defined our docs as main source of content for the Large Language Model(LLM) instance which will be scrapped weekly to digest new content. Access is granted via OIDC and Google.
38+
39+
Since we use Inkeep for more uses cases the project for docs is called "Giant Swarm customer facing". There in the integration you can see our docs and the configuration keys needed to bootstrap the widget. The code that triggers the render the widget is in `/src/assets/scripts/base.js` and the styles are part of `/static/css/inkeep.css`. Most of the options for the widget are defaulted and only style has be customized to fit our documentation's layout.
40+
41+
## Diagrams
42+
43+
We use [mermaid](https://mermaid.js.org/) for diagrams. You need to annotate the page previously in the front matter to load the mermaid code (`mermaid: true`). Then you can use the shortcode `{{< mermaid >}}` to add the diagram code.
44+
45+
## License
46+
47+
The content in this repository is licensed under the [Creative Commons Attribution ShareAlike](http://creativecommons.org/licenses/by-sa/4.0/) license.
48+
49+
For attribution, please use either:
50+
51+
- Giant Swarm
52+
- giantswarm.io
53+
54+
and link, if possible, to https://www.giantswarm.io/
55+

‎docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/main.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
annotations:
2+
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/main.yaml
3+
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/README.md
4+
application.giantswarm.io/team: sig-docs
5+
application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/values.schema.json
6+
chartApiVersion: v1
7+
chartFile: docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz
8+
dateCreated: '2024-12-12T17:15:49.150682'
9+
digest: eabf820a7f398620b47f02ed0d3a0d625090f66149c3341172fa26cc9591edab
10+
home: https://github.com/giantswarm/docs/
11+
icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg

‎docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/values.schema.json

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"$schema": "http://json-schema.org/schema#",
3+
"type": "object",
4+
"properties": {
5+
"name": {
6+
"type": "string"
7+
},
8+
"namespace": {
9+
"type": "string"
10+
},
11+
"resources": {
12+
"type": "object",
13+
"properties": {
14+
"limits": {
15+
"type": "object",
16+
"properties": {
17+
"cpu": {
18+
"type": "string"
19+
},
20+
"memory": {
21+
"type": "string"
22+
}
23+
}
24+
},
25+
"requests": {
26+
"type": "object",
27+
"properties": {
28+
"cpu": {
29+
"type": "string"
30+
},
31+
"memory": {
32+
"type": "string"
33+
}
34+
}
35+
}
36+
}
37+
}
38+
}
39+
}

‎index.yaml

+19-1
Original file line numberDiff line numberDiff line change
@@ -4336,6 +4336,24 @@ entries:
43364336
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/cloudnative-pg-0.0.6-4e31dd9d7bf59d880ec19f68e753692da00085eb.tgz
43374337
version: 0.0.6-4e31dd9d7bf59d880ec19f68e753692da00085eb
43384338
docs-app:
4339+
- annotations:
4340+
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/main.yaml
4341+
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/README.md
4342+
application.giantswarm.io/team: sig-docs
4343+
application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz-meta/values.schema.json
4344+
apiVersion: v1
4345+
appVersion: 0.0.1
4346+
created: "2024-12-12T17:15:50.892873378Z"
4347+
description: Giant Swarm documentation published at https://docs.giantswarm.io/
4348+
digest: eabf820a7f398620b47f02ed0d3a0d625090f66149c3341172fa26cc9591edab
4349+
home: https://github.com/giantswarm/docs/
4350+
icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg
4351+
name: docs-app
4352+
sources:
4353+
- https://github.com/giantswarm/docs
4354+
urls:
4355+
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8.tgz
4356+
version: 2.2.1355-9137788f573b8792ce64e936177c7d15465e5bc8
43394357
- annotations:
43404358
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-626c0ef06b52701db6c0053253090ada2608ed9b.tgz-meta/main.yaml
43414359
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1355-626c0ef06b52701db6c0053253090ada2608ed9b.tgz-meta/README.md
@@ -10714,4 +10732,4 @@ entries:
1071410732
urls:
1071510733
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/web-assets-app-0.12.2-794550fdee2ed66a0cd7ef5c7ba802a6626db441.tgz
1071610734
version: 0.12.2-794550fdee2ed66a0cd7ef5c7ba802a6626db441
10717-
generated: "2024-12-12T17:13:35.08017343Z"
10735+
generated: "2024-12-12T17:15:50.892042052Z"

0 commit comments

Comments
 (0)