Skip to content

Commit b7559ea

Browse files
authored
Merge pull request #716 from jakobmoellerdev/versioned_docs
chore: docusaurus bump to `3.9.1`, update image paths and dependencies in website
2 parents 37f2f0b + 579478c commit b7559ea

File tree

12 files changed

+5675
-2523
lines changed

12 files changed

+5675
-2523
lines changed

.github/workflows/test-docs.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ jobs:
1515
run:
1616
working-directory: ./website
1717
steps:
18-
- uses: actions/checkout@v4
18+
- uses: actions/checkout@v5
1919
with:
2020
fetch-depth: 0
21-
- uses: actions/setup-node@v4
21+
- uses: actions/setup-node@v5
2222
with:
23-
node-version: 18
23+
node-version: 20
2424

2525
- name: Install dependencies
2626
run: npm install --frozen-lockfile

examples/aws/webstack/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This example creates a ResourceGraphDefinition called `WebStack` comprised of
44
three other RGs: `WebApp`, `S3Bucket`, and `PodIdentity`
55

6-
![Nested RGD Instance](../../../images/architecture-diagrams/kro-WebStack.png)
6+
![Nested RGD Instance](../../../website/static/img/architecture/kro-WebStack.png)
77
_Figure 1: Nested RGD Example_
88

99
### Create ResourceGraphDefinitions

website/docs/docs/concepts/00-resource-group-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The `spec` section of a ResourceGraphDefinition contains two main components:
4343
- Dependencies between resources
4444
- Conditions for inclusion
4545
- Readiness criteria
46-
- [External References](#resourcegraphdefinition-more-about-resources)
46+
- [External References](#using-externalref-to-reference-objects-outside-the-resourcegraphdefinition)
4747

4848
This structure translates to YAML as follows:
4949

website/docs/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ sidebar_position: 100
8383
created by KRO instances.
8484
8585
86-
![ArgoCD RGD tracked Instance](../../static/img/KRO-ArgoCD-Tracking.png)
86+
![ArgoCD RGD tracked Instance](/img/KRO-ArgoCD-Tracking.png)
8787
8888
Note that the example shown above depicts ArgoCD's default resource tracking
8989
via annotations. You may choose to use `annotation+label` or just `label` and

website/docs/docs/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ standardized and streamlined manner.
3434

3535
<div align="center">
3636

37-
![End user interface - Custom API](../../../images/architecture-diagrams/KRO-Dev-Interface.png)
37+
![End user interface - Custom API](/img/architecture/KRO-Dev-Interface.png)
3838
_Figure 1: End user interface - Custom API_
3939

4040
</div>
@@ -56,7 +56,7 @@ handles the deployment and configuration of the required resources.
5656

5757
<div align="center">
5858

59-
![Platform Team Interface](../../../images/architecture-diagrams/KRO-Platform-Team.png)
59+
![Platform Team Interface](/img/architecture/KRO-Platform-Team.png)
6060
_Figure 2: ResourceGraphDefinition (RG) - Platform Team Interface_
6161

6262
</div>
@@ -74,7 +74,7 @@ requirements.
7474

7575
<div align="center">
7676

77-
![ResourceGraphDefinition Instance](../../../images/architecture-diagrams/KRO-Instance.png)
77+
![ResourceGraphDefinition Instance](/img/architecture/KRO-Instance.png)
7878
_Figure 3: ResourceGraphDefinition Instance (RGI)_
7979

8080
</div>

website/docusaurus.config.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@ const config: Config = {
2323
projectName: "kro", // Usually your repo name.
2424

2525
onBrokenLinks: "throw",
26-
onBrokenMarkdownLinks: "warn",
26+
markdown: {
27+
hooks: {
28+
onBrokenMarkdownLinks: "warn",
29+
},
30+
},
2731

2832
// Even if you don't use internationalization, you can use this field to set
2933
// useful metadata like html lang. For example, if your site is Chinese, you

0 commit comments

Comments
 (0)