Skip to content

Commit

Permalink
add docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz
Browse files Browse the repository at this point in the history
docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/README.md
docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/main.yaml
docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/values.schema.json
  • Loading branch information
catalogbot committed Dec 12, 2024
1 parent 923106f commit ba27ae4
Show file tree
Hide file tree
Showing 5 changed files with 124 additions and 1 deletion.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Giant Swarm user documentation

This is the main documentation repository for the documentation available at https://docs.giantswarm.io.

## Contributing

**We welcome any contributions on content to this repository in the form of pull requests!**

Please review the [Contribution guidelines](CONTRIBUTING.md) for guidelines on suggesting changes and getting them published this repository.

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.

While making changes, please use

```sh
make dev
```

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.

### Content linting

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:

```sh
make lint-prose
```

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.

To keep third party style rules up-to-date, please run `make lint-prose-update` and commit the resulting changes.

## Search

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.

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.

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.

## Diagrams

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.

## License

The content in this repository is licensed under the [Creative Commons Attribution ShareAlike](http://creativecommons.org/licenses/by-sa/4.0/) license.

For attribution, please use either:

- Giant Swarm
- giantswarm.io

and link, if possible, to https://www.giantswarm.io/

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/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/README.md
application.giantswarm.io/team: sig-docs
application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/values.schema.json
chartApiVersion: v1
chartFile: docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz
dateCreated: '2024-12-12T16:30:41.285504'
digest: 6b0b4965c948d89707f2623eb2072b0d6609709ff4a7867a84c61997d19595dc
home: https://github.com/giantswarm/docs/
icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"resources": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
}
},
"requests": {
"type": "object",
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
}
}
}
}
}
}
20 changes: 19 additions & 1 deletion index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4336,6 +4336,24 @@ entries:
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/cloudnative-pg-0.0.6-4e31dd9d7bf59d880ec19f68e753692da00085eb.tgz
version: 0.0.6-4e31dd9d7bf59d880ec19f68e753692da00085eb
docs-app:
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/README.md
application.giantswarm.io/team: sig-docs
application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz-meta/values.schema.json
apiVersion: v1
appVersion: 0.0.1
created: "2024-12-12T16:30:42.745807281Z"
description: Giant Swarm documentation published at https://docs.giantswarm.io/
digest: 6b0b4965c948d89707f2623eb2072b0d6609709ff4a7867a84c61997d19595dc
home: https://github.com/giantswarm/docs/
icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg
name: docs-app
sources:
- https://github.com/giantswarm/docs
urls:
- https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248.tgz
version: 2.2.1353-df546c5ae7c340f0211baf722d4e04854eed9248
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-35f848308b8ed9649f0ab8baba66e654c2232517.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1353-35f848308b8ed9649f0ab8baba66e654c2232517.tgz-meta/README.md
Expand Down Expand Up @@ -10624,4 +10642,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-12T16:29:39.841273527Z"
generated: "2024-12-12T16:30:42.745319977Z"

0 comments on commit ba27ae4

Please sign in to comment.