From aaaeac9f8d86e8398bac336f1c3da577e16fedf8 Mon Sep 17 00:00:00 2001
From: CatalogBot <catalogbot@giantswarm.io>
Date: Fri, 13 Dec 2024 15:21:07 +0000
Subject: [PATCH] add
 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz
 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/README.md
 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json

---
 ...ecb6b67c854b8cf6a282edee82039ba90da831.tgz | Bin 0 -> 2283 bytes
 .../README.md                                 | 121 ++++++++++++++++++
 .../main.yaml                                 |  11 ++
 .../values.schema.json                        |  39 ++++++
 index.yaml                                    |  20 ++-
 5 files changed, 190 insertions(+), 1 deletion(-)
 create mode 100644 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz
 create mode 100644 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/README.md
 create mode 100644 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
 create mode 100644 docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json

diff --git a/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz
new file mode 100644
index 0000000000000000000000000000000000000000..9fedca11e8027252029026894a05b693babb7609
GIT binary patch
literal 2283
zcmV<H2o(1piwG0|00000|0w_~VMtOiV@ORlOnEsqVl!4SWK%V1T2nbTPgYhoO;>Dc
zVQyr3R8em|NM&qo0PGuGbK5r3&-@iT>h+};Qq+efhcox!i*s$KNlp{@dXF6lTv2F9
z0tG<DisS!&1AwAPik2K#wR3mc7g5+xEP&kwK*pRZp9s-^wIospYm%jB$A&Nr!^wDT
zf5R|r{|=^u^RvNtI-G{*;b<J5g#+_=2I0{y>3~9MBG1A<tgGF*{}Ld1&Nb1D=PL35
zh!82G_J5Etl56#m$Sh#IpP?o((IkSU)<Q-7ehr^6y)5R2Y}@E_fznC#MN0I7%gooP
zv`>j9DNp*Fx#tgqVK5j?#{P7KbUv9+ru5=`Jinle2^n4tF-E)?hNG8r@-mFc#b^-d
z<dbhK>Su)IcGm7SULuJz{K`y!|N8Rk?du?m_nNMeWDzKq_(tbm(iKSyRKB81%)Yj9
za<&D|w%|9#bB_r23rfX!9>Hqh5h1F-VGsrbFGfWr6WTU?Zw!WOV==^>78&Ml-hwFR
zDN{>~f#|B!#^#oLyd`hW0qYCOvzjw3U*BWYsN7Jt1sPWu3RPzu^i!5Bb)Z&>mlLCC
z<2Fz6LQ+(b=RZKXx7s-2i@ohVV*OX~zZ{@HBLN(U|KVUdYQ_K2U>u&}|5HF~s+zw_
z5L&i*p2TYQ0!aM5K&9<702M_9=V505WSDWej^O;Q2avLiwWwNT!|?56X6p%#4ej+`
z3(!Z?abW!q!@;Dr{>S5Rd|Llc0k?Kp_Wt6=y%#~xq^PLhH#49tB?2y!zI*(p_rfvg
zwLnA7=f5G<n^qxBF`*f%UIb3GZ8u@1(bABiv}AeGtB`junw&NuJ&wH!U-z>&dQf5S
z=}ComA+8g5So%Y?RCH7ndkOaXqYZc6##k9HJ|9t6CuX;`!=~OQ+nk(yEGK*2|J>7^
zcXvw3|94R3e~p>h{h{jry2MnVRDl-9*$N!Y|Kn*Z|DO-1(^LL`3b?)Pe+Mg;MW9f_
zf~9Dp&fhZQ7P`a;zU$xJd4|e+eIrO7gI*$-tPFf%pQ$}K^h!D(VqCBs%bX8>*&4X>
z#dn7BGiX`l6ec74$g=BVv0yjQ^SAVv$M)H&ekGCUQk7F~EGc)&Kok@TW0<eE20=>Z
zn0A<Dv0FVtvRp5q_pS23RlSCp<#Tx`0iQvlNC`#g{j~?ZUwe<~2hTE|JKNN*ZLU3_
zmdeQ>LPT(T3oNH;5m#;v;4}PQaE)L^Y|*6%g(*_arJ;0Ef)B+UWsVwEz<A&7`wj@+
zWn;P0B&Uuwc#kO(g_}{`!<UhqBpCbib(8ZN<%-b*%+-mA;dFy?SsfO&SofZy+3v=8
zQ%Tt#enM|QbFZ#viD?$7W#7)FrWecU)f%7nJh(20=g>^p4x|6{qgXflxx>^6{v_zi
z|C>$Iu?m1g_dlcaVLShiC&N?ze+u}5{9h(v;u5gZn8AWe*vuB&th|3OF$ck8Wsxz8
zl&>?)wE`j$sFh)hh&3$9$|Q0iam-BEB`FLhHhmMSQF_XyQz8WBF~%<dgCu~S|MGlF
zU&fQg!WSPtB_DeMe9u;xgI*F1KUI+qNSgAG3MM13lBqgOeqpNy+aIP}N_RGL7*C<b
zsyU=cR_IC2UEftfm*C9oC^f2e6yt&vsSa8tQ7iCP<wel5CB&w@7*8KmUUcZqQGev}
z!;Ghlu3OrxjB$^ZfuZzE3BIr*9-vYv@hC+?i3dopbGlQZQccsD7IjKt4}p&Ozg@FO
zx(zxI|Ht7lY{macI5@@sCxQAUED=KWR|D?@%i{>Hs%hX=cmEzh?S|;yW#_0I!7uJ!
z!R8E$a;2@i9NO$|+Ehv)br(*yCRY&*?Y|W>mj1w$=5qapWlTHFrcQQJGotD8O-;@H
ziU2nAzGSWS)WDv87)TpR_Nf8b^vTjK7A$9az2y`<zRWed+(7^ci3^kx<EuilJh`Sz
zjEj`z$&X3StLE1?NDF&aUSsvG+*0PxD6^<_C}=xy-SA!=Iy_m2ecj!H=7Og@S^tFV
z2$~y_C0E)oH8?&ZOO`r<K^T_p3TYvkUcchG#v8pgMHcy``j<j!sl%#WA*DPMGs#Uw
zQ#ajIHxaxqa?LWla_Ph?@s#J9upDKrvp%$LNVlTCfmtz683mS+1nuQ0lNi@1EFywL
zamoVnsgOuz^W_VB<sWVLwVO?C!-@BH-;RMPa%PgPSc(b0R+OZ~y)m&MscL%Gy6YX!
z-*c`bQ(d&sNaBCy>Dr+G!BSLfQxtU&-tXRfU0f%iM36a4nP#{%tzyZ=?o{*P^39vJ
zV`oL0y3!_s9~bYqo=H?DTy5zDm%63G-wyMPo89|GcoDV~x*=a`T_5hoO?bVzekWe*
zq$nC|qhb#>903)@?rPcGknd-8RBi71z57EfarBR{qh#!|A~mHrDm9aQ-kKW5q2Hr!
z+b4)#M$m7!-Zwb*A`&C`;pd-c4U`FTjHFkXlJzxGp2y0Bg$9j4$#`60M@_7mu)NR}
zdRW7*cv@ummKXW%jLJ;w%ymO&qMs)$zv-M)7USz|GqIf1j(F21G=Q1V>nkQBxUFt)
zlsiDXq}153CmJ^i-`$tjp1U47!P7!V{V(GAabE*F^#0dq=l!qoIGmj7|EB=ELtjAf
zs+N<3%h``*A)<mGh=QKm{`Xgd{*1?0Ov%E&mHGD~PEhyUA@g=0QBjvWi4LBfEydn#
zK*sXR6=5lvrx?NDj}-iy6M<8xbI`H=6*=--pa<Xoob0Us;dpRb|4#wF@3&vXc8m79
zQ7;_x2;jN9e1aNut$#Q2#|r`n^Z$AK`=9escv}BY0*%Gqjs(wk?pNEl`@1_qO=N=F
z?cU2xdb1w5PyBN``zwTw@Be~1p&yQ^<Iws)pS0iq9!<j2`(IB2?T@e?`Z=I`p{BR_
zF0I$``4;90%Q1q4Ymxr%eavM-)0cnFHJth}uAY0;PjG@0oZ#&2KLG#$|NngDjRpWf
F006=xh@}7k

literal 0
HcmV?d00001

diff --git a/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/README.md b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/README.md
new file mode 100644
index 000000000..7935d4ddc
--- /dev/null
+++ b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/README.md
@@ -0,0 +1,121 @@
+# Giant Swarm user documentation
+
+This is the main documentation repository for the documentation available at https://docs.giantswarm.io.
+
+## Repository overview
+
+It holds the main **content** of our documentation. The documentation site is created using the static site generator [HUGO](http://gohugo.io/) based on markdown files in the `src/content/` directory of the `docs` repository.
+
+Additional content is tied in through the scripts
+
+- `scripts/aggregate-changelogs`: Aggregates changelog entries into the `src/content/changes` destination.
+- `scripts/collect-changelog-entries`: Collects changelog entries from all apps defined in `giantswarm/github` repository to create a weekly update.
+- `scripts/update-crd-reference`: Generates reference pages for our custom resource definitions in the `src/content/reference/platform-api` destination.
+- `scripts/update-external-repos`: Tutorials that need their own code repository. They must have a `docs` subfolder with the Markdown content and optionally some images. Configuration is found in `scripts/update-external-repos/repositories.txt`.
+- `scripts/update-helm-chart-reference`: Creates the cluster apps pages in the `src/content/reference/platform-api` destination.
+
+To update these external content types, the `Makefile` provides specific targets:
+
+- `make changes`
+- `make update-external-repos`
+- `make collect-changelog-entries`
+- `make update-cluster-app-reference`
+- `make update-crd-reference`
+
+All pull requests to this repository will trigger a build of the documentation site. The site is hosted in a Cluster API environment (`gazelle`) and it's deployed to https://docs.giantswarm.io automatically thanks to GitOps setup.
+
+## Contributing
+
+**We welcome any contributions on content to this repository in the form of pull requests!**
+
+Please review the [style guidelines](https://handbook.giantswarm.io/docs/content/docs-guide) before contributing.
+
+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.
+
+### Front matter
+
+Each documentation page consists of a markdown file that starts with some metadata called [front matter](https://gohugo.io/content-management/front-matter/). Some hints:
+
+- Please look at the other pages to get an idea of what the front matter is good for.
+- When your page's `title` is too long for the navigation menu, add a `linkTitle` field with a short title.
+- Please double-check whether the `description` is still up-to-date or could be improved. It will often show up Google search results.
+
+Special front matter fields we use:
+
+- `last_review_date`: Date of the last time somebody checked the entire page for validity.
+- `menu`: The menu entry under which the page should appear. Currently it's `principal` for the main menu,  vintage documentation is under `main`.
+- `owner`: List of GitHub team URLs for the team(s) or SIG(s) owning the page. The owning team/SIG is the one responsible for keeping the content up-to-date and useful.
+- `user_questions`: List of questions this article answers. Written from a user's perspective. E. g. _How do I ..._.
+
+## Shortcodes
+
+Shortcodes allow the use of a string in any number of places in the docs, while maintaining it only in one place. We use these to place, for example, configuration details. The goal here is to give users accurate, complete and up-to-date information.
+
+Shortcodes exist as one file each in the folder [src/layouts/shortcodes](https://github.com/giantswarm/docs/tree/master/src/layouts/shortcodes).
+
+A shortcode is used in a markdown file like this:
+
+```markdown
+... since version {{/*% first_aws_autoscaling_version */%}} and ...
+```
+
+### 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.
+
+## About the Header and Footer
+
+The header and footer are to be kept in sync with `www.giantswarm.io`. In order to do this we copy the HTML and CSS specific to those parts of the page.
+
+Files starting with `gs_` are involved in making the header and footer appear and behave correctly.
+
+`partials/gs_header.html` - The unedited html of the header at www.giantswarm.io
+
+`partials/gs_mobile_menu.html` - The unedited html of the mobile navigation menu at www.giantswarm.io
+
+`partials/gs_footer.html` - The unedited html of the footer at www.giantswarm.io
+
+`partials/gs_styles.html` - Automatically extracted styles which apply to
+                            elements found in the header and footer, as well
+                            as hand written override styles to make it play nicely
+                            with CSS already present in docs.
+
+`scripts/gs_menu.js`      - Hand written javascript that recreates the interactive
+                            functionality of the navigation menus.
+
+## 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/
diff --git a/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
new file mode 100644
index 000000000..b4c782be5
--- /dev/null
+++ b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
@@ -0,0 +1,11 @@
+annotations:
+  application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
+  application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.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.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json
+chartApiVersion: v1
+chartFile: docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz
+dateCreated: '2024-12-13T15:21:04.483776'
+digest: fee46da0ff37ef6452034409a14cea03a7eccd82169e027b84db805c81f176de
+home: https://github.com/giantswarm/docs/
+icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg
diff --git a/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json
new file mode 100644
index 000000000..d4194bc2a
--- /dev/null
+++ b/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json
@@ -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"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/index.yaml b/index.yaml
index 565fe4206..af72d7131 100644
--- a/index.yaml
+++ b/index.yaml
@@ -4428,6 +4428,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.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/main.yaml
+      application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.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.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz-meta/values.schema.json
+    apiVersion: v1
+    appVersion: 0.0.1
+    created: "2024-12-13T15:21:06.484130922Z"
+    description: Giant Swarm documentation published at https://docs.giantswarm.io/
+    digest: fee46da0ff37ef6452034409a14cea03a7eccd82169e027b84db805c81f176de
+    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.1364-73ecb6b67c854b8cf6a282edee82039ba90da831.tgz
+    version: 2.2.1364-73ecb6b67c854b8cf6a282edee82039ba90da831
   - annotations:
       application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1364-61789b27a5c9e2de246c1fbc376597a74410d07a.tgz-meta/main.yaml
       application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1364-61789b27a5c9e2de246c1fbc376597a74410d07a.tgz-meta/README.md
@@ -11853,4 +11871,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-13T15:15:32.180156424Z"
+generated: "2024-12-13T15:21:06.483337927Z"