From 1d85aa57e45c5c65345acf9d7f66e1407f3f5868 Mon Sep 17 00:00:00 2001 From: CatalogBot Date: Fri, 13 Dec 2024 07:13:19 +0000 Subject: [PATCH] add docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/README.md docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json --- ...e95a42f012884c45390c55b2ba48bad433b2c7.tgz | Bin 0 -> 2285 bytes .../README.md | 55 ++++++++++++++++++ .../main.yaml | 11 ++++ .../values.schema.json | 39 +++++++++++++ index.yaml | 20 ++++++- 5 files changed, 124 insertions(+), 1 deletion(-) create mode 100644 docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz create mode 100644 docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/README.md create mode 100644 docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml create mode 100644 docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json diff --git a/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz new file mode 100644 index 0000000000000000000000000000000000000000..6fe3934eea1449b1c0371ab141855390a39fb143 GIT binary patch literal 2285 zcmVDc zVQyr3R8em|NM&qo0PGuGliRlOp7|?wl;$NhDeBwiOdqa3H_60yHNG@`%s}9ZLQE0} z0LrIa?!R{cP!vh=r1M3&b6f3;DC{Q|!0rMdV@{P%gy_Fs5vhX>$Jm;Ed#&Z>U z07QtCQTsng7|FHzL}V5)-p^2zm}nBgN^7B_e!qrKm|hhNL$+)5xj^Y8`ywTJ$z|qi zRNALRlawd@?cDQ+!7vz%CNqDwz*iG89xlVd@a4-f9ZyEDLOPi&h6^%&xgha)G+GSl zEYQhszOksE5tiFod(e1^B+l>)GyTJx%d2;9f-F90x<-;kpjhG?od-$RBrQ<+imovG z(#FZz7C762Ulh+hBG^wT72|mX>w!mvsQ!jQ7!14^6_reA+w`q57_N=Q5OZ2&n7erk zqFAI%tuO|nt4x9qtw)cqjU&a4&fc}gGa3ubRgW0GR|3`z#^c?@60$Nkm z{8fU`vd!}(R%SJDPp0F@`X7daX>0wD$HU=y{XYfV+GW}MiyQY|1U-|YqJH1ZfU=YbxJ>%)@vGho z$DlU?4K-idu?g*3&4W~h1*IMKGtX-o0pY+JN*p_9}ec&)(=k zg}tXI72buoPTX~;Th zPj}wkIVJz!L6!eCW@h(?s{iu}Q-M+iTAXGpa5VpqXRZ7{84V`q{Qneid)xm8)+~!a zp@t<((L|lUWyURZg%Nzyzq|7cmG|aGkUR#xLNHkw_|iU8dvNHLbUwtmWI2{OAN;a4 zaOaEf4dd^iWsy^uj_f1Lu8ZZ8-9XRZ(PJLlXQ%qLM50SoPPwt9+$jT5P$-OHvDp~} zDOq6JVV1@2^a#mvy@cM^%KuvR8fKQy<)H-p4iZI5C_?YAJ?Q=1drUugmhs%#ruJ=f z?E$q^P6iPog4R5vhm?BZQ9n}MT8Oce4vA@_fIj>Q!89l;WoroAtHz=3YVNr|q;3=Bz zZj3jTl-=Pc^bRxk>Uvg~W`SDu?ObYlv7BD5@oCS4>vDLG&4k@B`cFTKb+ey4Or7CR zg0B3(-87x5062F4Gnx$B`F|3I=luT^@EQ5POv1z^V5KpGC6}nXpSz7))*YCRC&JluM^X2+U)QUjPP406qWJ zWJX`b)8*0^AAd_e^#b^otuY6^A{u_EA{~%4<)0KxM_wgUb(s9ZRt>g4Ou3ZqY~(PW zL5)>&NRh13lbpN0tAeh;nb}clRO=|lB`H!Jv`V5@;H}Dwpl3^nZFw=CJ*d3s(3_+F z#O231PZ`~`v{xD99xDSw>6a3GVMRPZrBLEgii8pmkY49>r$VKgrZX+-oWdRg9r1s+ zW>0h*bR_r^-EYHgzB#c-ba?l5nNT%z^m^5J%HK`(Y?#gQ8|L2 z+`WR$85ZSATX#9M-QBdQltAh(oNP_5A{g3#Yi2C{jw#LM<}J&Zc9?CQ?4)Ky)79IW zn)?+2Z0CK+TI;ES1N|_NHk2Gv1F-FrrCTmp&h%!-DR_LDYj(MZ01y(FC?&>Mg=Beh zO;;EfDa(`Zlbl!0Z*Gtl_Nu(b>RY*`%pXx^QR`69cHp|9gQEg07)IoT^d+&8|oq!TS7A$3&;oh{0B^Ucs&4h?yt1GGy@jSUB)ag*@ya}&Ep*iXB3_*KHLzpve~tFu{~C{n<8%H06kvDg zO9)=qa&mAv|Gq3lRPY^9&~w}W{(8`#^Z1G>S=hHS|6ari>Yh7f-t8kQ>T)O1!Lzre zIJgbSSbn)CEG3H+BN+UVf`5A=a1M12I@Z4;Cw>d`==-13z4bqw%+BloDZuyr_KVnV z(Ox&|g;O2@Ja?DRP=l`Z??(P~LEvcqpR~XKnT!VK_5UQ$SnTac@NDOPwSBw4zZ29% zCaB%+z1*ZX>w){kKew~LKl8Iy}Gs^(4^#2HprxTqZPq{^wl7nIGf&xkvpBXE?(dE-wBP00960r3V3{ H06+i$eWZ-@ literal 0 HcmV?d00001 diff --git a/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/README.md b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/README.md new file mode 100644 index 000000000..1943a3de7 --- /dev/null +++ b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/README.md @@ -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/ + diff --git a/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml new file mode 100644 index 000000000..515d42594 --- /dev/null +++ b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.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.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml + application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.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.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json +chartApiVersion: v1 +chartFile: docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz +dateCreated: '2024-12-13T07:13:16.638140' +digest: ea6ffeab7779b4ecf45f2ca5dadd90f5f2754083d54617127a3ea666966fcc01 +home: https://github.com/giantswarm/docs/ +icon: https://s.giantswarm.io/app-icons/giantswarm/1/light.svg diff --git a/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json new file mode 100644 index 000000000..d4194bc2a --- /dev/null +++ b/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.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 eea9f62fa..c6cd50729 100644 --- a/index.yaml +++ b/index.yaml @@ -4446,6 +4446,24 @@ entries: urls: - https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1357-dd7250e2333f5c523f5495013345afcd35a22237.tgz version: 2.2.1357-dd7250e2333f5c523f5495013345afcd35a22237 + - annotations: + application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/main.yaml + application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.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.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz-meta/values.schema.json + apiVersion: v1 + appVersion: 0.0.1 + created: "2024-12-13T07:13:18.704531614Z" + description: Giant Swarm documentation published at https://docs.giantswarm.io/ + digest: ea6ffeab7779b4ecf45f2ca5dadd90f5f2754083d54617127a3ea666966fcc01 + 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.1357-7be95a42f012884c45390c55b2ba48bad433b2c7.tgz + version: 2.2.1357-7be95a42f012884c45390c55b2ba48bad433b2c7 - annotations: application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1356-be4dfb4136b6c7a2f27f219b31c83bb17898750e.tgz-meta/main.yaml application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-operations-platform-test-catalog/docs-app-2.2.1356-be4dfb4136b6c7a2f27f219b31c83bb17898750e.tgz-meta/README.md @@ -11007,4 +11025,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-13T07:06:50.862076009Z" +generated: "2024-12-13T07:13:18.7037684Z"