Skip to content

Commit 3eb46ea

Browse files
rothgarrothgar
authored
Merge pull request #62 from rothgar/ref-docs-structure
fix: move reference documents into configuration
2 parents 31a495c + 52a4fe5 commit 3eb46ea

83 files changed

Lines changed: 3452 additions & 142 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Makefile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ generate-talos-reference: ## Generate Talos reference docs and convert to MDX
127127
docker run --rm -u $(shell id -u):$(shell id -g) -v $(PWD)/_out/docs:/docs $(TALOSCTL_IMAGE) docs /docs
128128
@echo "Converting generated docs to MDX..."
129129
docker run --rm -u $(shell id -u):$(shell id -g) -v $(PWD):/workspace $(DOCS_CONVERT_IMAGE) \
130-
/workspace/_out/docs /workspace/public/talos/$(TALOS_VERSION)/reference
130+
/workspace/_out/docs /workspace/public/talos/$(TALOS_VERSION)/reference/configuration/
131131
rm -rf _out/docs
132-
@echo "Reference documentation generated in talos/$(TALOS_VERSION)/reference/"
132+
@echo "Reference documentation generated in public/talos/$(TALOS_VERSION)/reference/configuration"
133133

134134
.PHONY: generate-talos-reference-local
135135
generate-talos-reference-local: ## Generate Talos reference docs using local Go build
@@ -138,6 +138,6 @@ generate-talos-reference-local: ## Generate Talos reference docs using local Go
138138
mkdir -p _out/docs
139139
docker run --rm -u $(shell id -u):$(shell id -g) -v $(PWD)/_out/docs:/docs $(TALOSCTL_IMAGE) docs /docs
140140
@echo "Converting generated docs to MDX..."
141-
cd docs-convert && go run main.go ../_out/docs ../public/talos/$(TALOS_VERSION)/reference
142-
@echo "Reference documentation generated in public/talos/$(TALOS_VERSION)/reference/"
141+
cd docs-convert && go run main.go ../_out/docs ../public/talos/$(TALOS_VERSION)/reference/configuration/
142+
@echo "Reference documentation generated in public/talos/$(TALOS_VERSION)/reference/configuration/"
143143

‎public/docs.json‎

Lines changed: 74 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -302,39 +302,40 @@
302302
{
303303
"group": "Reference",
304304
"pages": [
305-
"talos/v1.11/reference/v1alpha1/config",
305+
"talos/v1.11/reference/configuration/overview",
306+
"talos/v1.11/reference/configuration/v1alpha1/config",
306307
"talos/v1.11/reference/kernel",
307308
"talos/v1.11/reference/cli",
308-
"talos/v1.11/reference/extensions/extensionserviceconfig",
309-
"talos/v1.11/reference/hardware/pcidriverrebindconfig",
310-
"talos/v1.11/reference/security/trustedrootsconfig",
311-
"talos/v1.11/reference/siderolink/siderolinkconfig",
309+
"talos/v1.11/reference/configuration/extensions/extensionserviceconfig",
310+
"talos/v1.11/reference/configuration/hardware/pcidriverrebindconfig",
311+
"talos/v1.11/reference/configuration/security/trustedrootsconfig",
312+
"talos/v1.11/reference/configuration/siderolink/siderolinkconfig",
312313
{
313314
"group": "Block",
314315
"pages": [
315-
"talos/v1.11/reference/block/existingvolumeconfig",
316-
"talos/v1.11/reference/block/rawvolumeconfig",
317-
"talos/v1.11/reference/block/swapvolumeconfig",
318-
"talos/v1.11/reference/block/uservolumeconfig",
319-
"talos/v1.11/reference/block/volumeconfig",
320-
"talos/v1.11/reference/block/zswapconfig"
316+
"talos/v1.11/reference/configuration/block/existingvolumeconfig",
317+
"talos/v1.11/reference/configuration/block/rawvolumeconfig",
318+
"talos/v1.11/reference/configuration/block/swapvolumeconfig",
319+
"talos/v1.11/reference/configuration/block/uservolumeconfig",
320+
"talos/v1.11/reference/configuration/block/volumeconfig",
321+
"talos/v1.11/reference/configuration/block/zswapconfig"
321322
]
322323
},
323324
{
324325
"group": "Network",
325326
"pages": [
326-
"talos/v1.11/reference/network/ethernetconfig",
327-
"talos/v1.11/reference/network/kubespanendpointsconfig",
328-
"talos/v1.11/reference/network/networkdefaultactionconfig",
329-
"talos/v1.11/reference/network/networkruleconfig"
327+
"talos/v1.11/reference/configuration/network/ethernetconfig",
328+
"talos/v1.11/reference/configuration/network/kubespanendpointsconfig",
329+
"talos/v1.11/reference/configuration/network/networkdefaultactionconfig",
330+
"talos/v1.11/reference/configuration/network/networkruleconfig"
330331
]
331332
},
332333
{
333334
"group": "Runtime",
334335
"pages": [
335-
"talos/v1.11/reference/runtime/eventsinkconfig",
336-
"talos/v1.11/reference/runtime/kmsglogconfig",
337-
"talos/v1.11/reference/runtime/watchdogtimerconfig"
336+
"talos/v1.11/reference/configuration/runtime/eventsinkconfig",
337+
"talos/v1.11/reference/configuration/runtime/kmsglogconfig",
338+
"talos/v1.11/reference/configuration/runtime/watchdogtimerconfig"
338339
]
339340
}
340341
]
@@ -598,35 +599,36 @@
598599
{
599600
"group": "Reference",
600601
"pages": [
601-
"talos/v1.10/reference/v1alpha1/config",
602+
"talos/v1.10/reference/configuration/overview",
603+
"talos/v1.10/reference/configuration/v1alpha1/config",
602604
"talos/v1.10/reference/kernel",
603605
"talos/v1.10/reference/cli",
604-
"talos/v1.10/reference/extensions/extensionserviceconfig",
605-
"talos/v1.10/reference/hardware/pcidriverrebindconfig",
606-
"talos/v1.10/reference/security/trustedrootsconfig",
607-
"talos/v1.10/reference/siderolink/siderolinkconfig",
606+
"talos/v1.10/reference/configuration/extensions/extensionserviceconfig",
607+
"talos/v1.10/reference/configuration/hardware/pcidriverrebindconfig",
608+
"talos/v1.10/reference/configuration/security/trustedrootsconfig",
609+
"talos/v1.10/reference/configuration/siderolink/siderolinkconfig",
608610
{
609611
"group": "Block",
610612
"pages": [
611-
"talos/v1.10/reference/block/uservolumeconfig",
612-
"talos/v1.10/reference/block/volumeconfig"
613+
"talos/v1.10/reference/configuration/block/uservolumeconfig",
614+
"talos/v1.10/reference/configuration/block/volumeconfig"
613615
]
614616
},
615617
{
616618
"group": "Network",
617619
"pages": [
618-
"talos/v1.10/reference/network/ethernetconfig",
619-
"talos/v1.10/reference/network/kubespanendpointsconfig",
620-
"talos/v1.10/reference/network/networkdefaultactionconfig",
621-
"talos/v1.10/reference/network/networkruleconfig"
620+
"talos/v1.10/reference/configuration/network/ethernetconfig",
621+
"talos/v1.10/reference/configuration/network/kubespanendpointsconfig",
622+
"talos/v1.10/reference/configuration/network/networkdefaultactionconfig",
623+
"talos/v1.10/reference/configuration/network/networkruleconfig"
622624
]
623625
},
624626
{
625627
"group": "Runtime",
626628
"pages": [
627-
"talos/v1.10/reference/runtime/eventsinkconfig",
628-
"talos/v1.10/reference/runtime/kmsglogconfig",
629-
"talos/v1.10/reference/runtime/watchdogtimerconfig"
629+
"talos/v1.10/reference/configuration/runtime/eventsinkconfig",
630+
"talos/v1.10/reference/configuration/runtime/kmsglogconfig",
631+
"talos/v1.10/reference/configuration/runtime/watchdogtimerconfig"
630632
]
631633
}
632634
]
@@ -888,27 +890,28 @@
888890
{
889891
"group": "Reference",
890892
"pages": [
891-
"talos/v1.9/reference/v1alpha1/config",
893+
"talos/v1.9/reference/configuration/overview",
894+
"talos/v1.9/reference/configuration/v1alpha1/config",
892895
"talos/v1.9/reference/kernel",
893896
"talos/v1.9/reference/cli",
894-
"talos/v1.9/reference/extensions/extensionserviceconfig",
895-
"talos/v1.9/reference/security/trustedrootsconfig",
896-
"talos/v1.9/reference/siderolink/siderolinkconfig",
897-
"talos/v1.9/reference/block/volumeconfig",
897+
"talos/v1.9/reference/configuration/extensions/extensionserviceconfig",
898+
"talos/v1.9/reference/configuration/security/trustedrootsconfig",
899+
"talos/v1.9/reference/configuration/siderolink/siderolinkconfig",
900+
"talos/v1.9/reference/configuration/block/volumeconfig",
898901
{
899902
"group": "Network",
900903
"pages": [
901-
"talos/v1.9/reference/network/kubespanendpointsconfig",
902-
"talos/v1.9/reference/network/networkdefaultactionconfig",
903-
"talos/v1.9/reference/network/networkruleconfig"
904+
"talos/v1.9/reference/configuration/network/kubespanendpointsconfig",
905+
"talos/v1.9/reference/configuration/network/networkdefaultactionconfig",
906+
"talos/v1.9/reference/configuration/network/networkruleconfig"
904907
]
905908
},
906909
{
907910
"group": "Runtime",
908911
"pages": [
909-
"talos/v1.9/reference/runtime/eventsinkconfig",
910-
"talos/v1.9/reference/runtime/kmsglogconfig",
911-
"talos/v1.9/reference/runtime/watchdogtimerconfig"
912+
"talos/v1.9/reference/configuration/runtime/eventsinkconfig",
913+
"talos/v1.9/reference/configuration/runtime/kmsglogconfig",
914+
"talos/v1.9/reference/configuration/runtime/watchdogtimerconfig"
912915
]
913916
}
914917
]
@@ -1170,27 +1173,28 @@
11701173
{
11711174
"group": "Reference",
11721175
"pages": [
1173-
"talos/v1.8/reference/v1alpha1/config",
1176+
"talos/v1.8/reference/configuration/overview",
1177+
"talos/v1.8/reference/configuration/v1alpha1/config",
11741178
"talos/v1.8/reference/kernel",
11751179
"talos/v1.8/reference/cli",
1176-
"talos/v1.8/reference/extensions/extensionserviceconfig",
1177-
"talos/v1.8/reference/security/trustedrootsconfig",
1178-
"talos/v1.8/reference/siderolink/siderolinkconfig",
1179-
"talos/v1.8/reference/block/volumeconfig",
1180+
"talos/v1.8/reference/configuration/extensions/extensionserviceconfig",
1181+
"talos/v1.8/reference/configuration/security/trustedrootsconfig",
1182+
"talos/v1.8/reference/configuration/siderolink/siderolinkconfig",
1183+
"talos/v1.8/reference/configuration/block/volumeconfig",
11801184
{
11811185
"group": "Network",
11821186
"pages": [
1183-
"talos/v1.8/reference/network/kubespanendpointsconfig",
1184-
"talos/v1.8/reference/network/networkdefaultactionconfig",
1185-
"talos/v1.8/reference/network/networkruleconfig"
1187+
"talos/v1.8/reference/configuration/network/kubespanendpointsconfig",
1188+
"talos/v1.8/reference/configuration/network/networkdefaultactionconfig",
1189+
"talos/v1.8/reference/configuration/network/networkruleconfig"
11861190
]
11871191
},
11881192
{
11891193
"group": "Runtime",
11901194
"pages": [
1191-
"talos/v1.8/reference/runtime/eventsinkconfig",
1192-
"talos/v1.8/reference/runtime/kmsglogconfig",
1193-
"talos/v1.8/reference/runtime/watchdogtimerconfig"
1195+
"talos/v1.8/reference/configuration/runtime/eventsinkconfig",
1196+
"talos/v1.8/reference/configuration/runtime/kmsglogconfig",
1197+
"talos/v1.8/reference/configuration/runtime/watchdogtimerconfig"
11941198
]
11951199
}
11961200
]
@@ -1447,24 +1451,25 @@
14471451
{
14481452
"group": "Reference",
14491453
"pages": [
1450-
"talos/v1.7/reference/v1alpha1/config",
1454+
"talos/v1.7/reference/configuration/overview",
1455+
"talos/v1.7/reference/configuration/v1alpha1/config",
14511456
"talos/v1.7/reference/kernel",
14521457
"talos/v1.7/reference/cli",
1453-
"talos/v1.7/reference/extensions/extensionserviceconfig",
1454-
"talos/v1.7/reference/siderolink/siderolinkconfig",
1458+
"talos/v1.7/reference/configuration/extensions/extensionserviceconfig",
1459+
"talos/v1.7/reference/configuration/siderolink/siderolinkconfig",
14551460
{
14561461
"group": "Network",
14571462
"pages": [
1458-
"talos/v1.7/reference/network/networkdefaultactionconfig",
1459-
"talos/v1.7/reference/network/networkruleconfig"
1463+
"talos/v1.7/reference/configuration/network/networkdefaultactionconfig",
1464+
"talos/v1.7/reference/configuration/network/networkruleconfig"
14601465
]
14611466
},
14621467
{
14631468
"group": "Runtime",
14641469
"pages": [
1465-
"talos/v1.7/reference/runtime/eventsinkconfig",
1466-
"talos/v1.7/reference/runtime/kmsglogconfig",
1467-
"talos/v1.7/reference/runtime/watchdogtimerconfig"
1470+
"talos/v1.7/reference/configuration/runtime/eventsinkconfig",
1471+
"talos/v1.7/reference/configuration/runtime/kmsglogconfig",
1472+
"talos/v1.7/reference/configuration/runtime/watchdogtimerconfig"
14681473
]
14691474
}
14701475
]
@@ -1715,22 +1720,23 @@
17151720
{
17161721
"group": "Reference",
17171722
"pages": [
1718-
"talos/v1.6/reference/v1alpha1/config",
1723+
"talos/v1.6/reference/configuration/overview",
1724+
"talos/v1.6/reference/configuration/v1alpha1/config",
17191725
"talos/v1.6/reference/kernel",
17201726
"talos/v1.6/reference/cli",
1721-
"talos/v1.6/reference/siderolink/siderolinkconfig",
1727+
"talos/v1.6/reference/configuration/siderolink/siderolinkconfig",
17221728
{
17231729
"group": "Network",
17241730
"pages": [
1725-
"talos/v1.6/reference/network/networkdefaultactionconfig",
1726-
"talos/v1.6/reference/network/networkruleconfig"
1731+
"talos/v1.6/reference/configuration/network/networkdefaultactionconfig",
1732+
"talos/v1.6/reference/configuration/network/networkruleconfig"
17271733
]
17281734
},
17291735
{
17301736
"group": "Runtime",
17311737
"pages": [
1732-
"talos/v1.6/reference/runtime/eventsinkconfig",
1733-
"talos/v1.6/reference/runtime/kmsglogconfig"
1738+
"talos/v1.6/reference/configuration/runtime/eventsinkconfig",
1739+
"talos/v1.6/reference/configuration/runtime/kmsglogconfig"
17341740
]
17351741
}
17361742
]

public/talos/v1.10/reference/block/uservolumeconfig.mdx renamed to public/talos/v1.10/reference/configuration/block/uservolumeconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/block/volumeconfig.mdx renamed to public/talos/v1.10/reference/configuration/block/volumeconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/extensions/extensionserviceconfig.mdx renamed to public/talos/v1.10/reference/configuration/extensions/extensionserviceconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/hardware/pcidriverrebindconfig.mdx renamed to public/talos/v1.10/reference/configuration/hardware/pcidriverrebindconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/network/ethernetconfig.mdx renamed to public/talos/v1.10/reference/configuration/network/ethernetconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/network/kubespanendpointsconfig.mdx renamed to public/talos/v1.10/reference/configuration/network/kubespanendpointsconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/network/networkdefaultactionconfig.mdx renamed to public/talos/v1.10/reference/configuration/network/networkdefaultactionconfig.mdx

File renamed without changes.

public/talos/v1.10/reference/network/networkruleconfig.mdx renamed to public/talos/v1.10/reference/configuration/network/networkruleconfig.mdx

File renamed without changes.

0 commit comments

Comments
 (0)