Merge branch 'main' of github.com:metal-stack/docs-new into update-links

Author: vknabel

.github/workflows/build.yaml

@@ -21,7 +21,7 @@ jobs:
           bun-version: v1.2
 
       - name: Install Dependencies
-        run: bun install --frozen-lockfile --production
+        run: bun install --frozen-lockfile --production --ignore-scripts
 
       - name: Build Website
         run: bun run build

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npx lint-staged

README.md

@@ -17,9 +17,9 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
 │   ├── 2024
 │   └── 2025
 ├── docs                    # docs folder split by different scopes
-│   ├── contributing        # guidlines for contributors
+│   ├── contributing        # guidelines for contributors
 │   ├── docs                # documentation pages
-│   ├── references          # auto-genereted references of componets and apis
+│   ├── references          # auto-generated references of components and apis
 ├── scripts                 # custom scripts (e.g: resolving component documentation)
 ├── src                     # custom routes and react
 │   ├── components
@@ -72,6 +72,17 @@ This file is used to generate the sidebar.
 }
 ```
 
+## Embedding drawio images
+
+> ⚠️ referenced `.drawio.svg` images throw **warnings** because of unsupported file-types. We save `.drawio` files separatly and export them as `svg`. Issue is also known in [docusaurus](https://github.com/facebook/docusaurus/issues/9715)
+
+Some svgs still can have problems e.g:
+
+- `drawio.svg` files pulled by references
+- too large svg
+
+For this we have a pre-commit hook, which optimizes them with [svgo](https://github.com/svg/svgo)
+
 ## Blog
 
 In order to add a blog-post follow this template. If a new author is referenced you have to add the author to the `authors.yaml`.
@@ -97,26 +108,34 @@ tags:
 
 <YOUR ARTICLE>
 ```
+
 ## Setup & Build
-Reqires Bun as .js runtime.
+
+Requires Bun as .js runtime.
 
 Run the following command to install dependencies:
+
 ```
 bun install
 ```
 
 To generate a local preview use:
+
 ```
 bun run start
 ```
 
 To update the dependencies for the Reference pages:
+
 ```
 bun run fetch-readmes
 ```
+
 ## Component references
-Ensure first, that all files in the docs folder are updated and ready to freeze. Also execute `bun run fetch-readmes` to update files from components and apis. 
+
+Ensure first, that all files in the docs folder are updated and ready to freeze. Also execute `bun run fetch-readmes` to update files from components and apis.
 All components are referenced in the `/scripts/components.json` file. Use this minimal template to add a new component:
+
 ```json
 {
         "name": "metalctl", // name of the component, will appear in the navigation
@@ -126,12 +145,17 @@ All components are referenced in the `/scripts/components.json` file. Use this m
         "withDocs": true // set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved.
 },
 ```
+
 The `tag` property will be updated automatically from the release-vector file.
+
 ## Document Versioning
+
 You create a new version with:
+
 ```
 bun run docusaurus docs:version v0.21.6
 ```
+
 Now, the new version will be create and the latest files will be copied to the "`versioned`" folders.
 
 ## Comparison

blog/2021/04-cluster-api-provider/cluster_api.drawio

@@ -0,0 +1,40 @@
+<mxfile host="65bd71144e">
+    <diagram id="ToPi5NqXSybOOjagKnuQ" name="Page-1">
+        <mxGraphModel dx="2104" dy="701" grid="0" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-1" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
+                    <mxGeometry x="62.01" y="200" width="640" height="548" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-2" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" parent="1" vertex="1">
+                    <mxGeometry x="87" y="275" width="590" height="265" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-5" value="&lt;font style=&quot;font-size: 30px&quot;&gt;Management cluster&lt;/font&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+                    <mxGeometry x="228.38" y="222" width="307.25" height="37" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-6" value="&lt;font style=&quot;font-size: 26px&quot;&gt;Core controllers&lt;/font&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+                    <mxGeometry x="255.75" y="291" width="238.5" height="37" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-7" value="&lt;font style=&quot;font-size: 20px&quot;&gt;... controller&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
+                    <mxGeometry x="410" y="406" width="217" height="117" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-9" value="&lt;font style=&quot;font-size: 20px&quot;&gt;Machine controller&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
+                    <mxGeometry x="273.51" y="372" width="217" height="117" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-10" value="&lt;font style=&quot;font-size: 20px&quot;&gt;Cluster controller&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
+                    <mxGeometry x="115" y="339.5" width="217" height="117" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-11" value="&lt;font style=&quot;font-size: 20px&quot;&gt;... provider&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
+                    <mxGeometry x="410" y="609" width="217" height="117" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-12" value="&lt;font style=&quot;font-size: 20px&quot;&gt;random provider&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
+                    <mxGeometry x="266.5" y="582" width="217" height="117" as="geometry"/>
+                </mxCell>
+                <mxCell id="qUONc3NZkDFU0F-GtsOM-13" value="&lt;font style=&quot;font-size: 20px&quot;&gt;metal-stack provider&lt;/font&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
+                    <mxGeometry x="115" y="554" width="217" height="117" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>