Skip to content

Commit 467847f

Browse files
michaeltlombardimichaeltlombardi
authored
(MAINT) Decompose TOC (MicrosoftDocs#362)
* (MAINT) Decompose TOC Prior to this change, the TOC for the documentation was contained in a single top-level configuration file, which was difficult to parse, reason about, and maintain. This change decomposes the TOC into smaller files colocated with the documentation for a smaller scope of management, easier maintanence, and readability. * (MAINT) Add missing TOC entries.
1 parent 13fe343 commit 467847f

File tree

7 files changed

+337
-250
lines changed

7 files changed

+337
-250
lines changed

‎dsc/docs-conceptual/dsc-3.0/concepts/toc.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
items:
2+
- name: DSC configuration documents
3+
items:
4+
- name: Overview
5+
href: configuration-documents/overview.md
6+
- name: DSC resources
7+
items:
8+
- name: Overview
9+
href: resources/overview.md
10+
- name: Resource instances
11+
href: resources/instances.md
12+
- name: Resource operations
13+
href: resources/operations.md
14+
- name: Resource properties
15+
href: resources/properties.md
16+
- name: Resource capabilities
17+
href: resources/capabilities.md
18+
- name: Resource kinds
19+
href: resources/kinds.md
20+
- name: Anatomy of a command resource
21+
href: resources/anatomy.md
22+
- name: Enhanced authoring
23+
href: enhanced-authoring.md
24+
- name: Output accessibility
25+
href: output-accessibility.md

‎dsc/docs-conceptual/dsc-3.0/reference/cli/toc.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
items:
2+
- name: dsc
3+
href: index.md
4+
- name: dsc completer
5+
href: completer/index.md
6+
- name: dsc config subcommands
7+
items:
8+
- name: dsc config
9+
href: config/index.md
10+
- name: dsc config export
11+
href: config/export.md
12+
- name: dsc config get
13+
href: config/get.md
14+
- name: dsc config set
15+
href: config/set.md
16+
- name: dsc config test
17+
href: config/test.md
18+
- name: dsc extension subcommands
19+
items:
20+
- name: dsc extension
21+
href: extension/index.md
22+
- name: dsc extension list
23+
href: extension/list.md
24+
- name: dsc resource subcommands
25+
items:
26+
- name: dsc resource
27+
href: resource/index.md
28+
- name: dsc resource delete
29+
href: resource/delete.md
30+
- name: dsc resource export
31+
href: resource/export.md
32+
- name: dsc resource get
33+
href: resource/get.md
34+
- name: dsc resource list
35+
href: resource/list.md
36+
- name: dsc resource schema
37+
href: resource/schema.md
38+
- name: dsc resource set
39+
href: resource/set.md
40+
- name: dsc resource test
41+
href: resource/test.md
42+
- name: dsc schema
43+
href: schema/index.md

‎dsc/docs-conceptual/dsc-3.0/reference/resources/toc.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
items:
2+
- name: Builtin resources
3+
items:
4+
- name: Overview
5+
href: builtin.md
6+
- name: DSC.PackageManagement/APT
7+
items:
8+
- name: DSC resource
9+
href: DSC/PackageManagement/APT/index.md
10+
- name: Examples
11+
items:
12+
- name: Manage packages
13+
href: DSC/PackageManagement/APT/examples/manage-packages-with-apt.md
14+
- name: Microsoft.DSC.Debug/Echo
15+
items:
16+
- name: DSC resource
17+
href: Microsoft/DSC/Debug/Echo/index.md
18+
- name: Examples
19+
items:
20+
- name: Basic usage
21+
href: Microsoft/DSC/Debug/Echo/examples/basic-echo-example.md
22+
- name: Microsoft.DSC/PowerShell
23+
items:
24+
- name: DSC resource
25+
href: Microsoft/Dsc/PowerShell/index.md
26+
- name: Microsoft/OSInfo
27+
items:
28+
- name: DSC resource
29+
href: Microsoft/OSInfo/index.md
30+
- name: Examples
31+
items:
32+
- name: Validate OS with dsc resource commands
33+
href: Microsoft/OSInfo/examples/validate-with-dsc-resource.md
34+
- name: Validate OS in a configuration
35+
href: Microsoft/OSInfo/examples/validate-with-dsc-resource.md
36+
- name: Microsoft.Windows/RebootPending
37+
items:
38+
- name: DSC resource
39+
href: Microsoft/Windows/RebootPending/index.md
40+
- name: Examples
41+
items:
42+
- name: Check for pending reboot
43+
href: Microsoft/Windows/RebootPending/examples/check-for-pending-reboot.md
44+
- name: Use in configuration
45+
href: Microsoft/Windows/RebootPending/examples/use-rebootpending-in-configuration.md
46+
- name: Microsoft.Windows/Registry
47+
items:
48+
- name: DSC resource
49+
href: Microsoft/Windows/Registry/index.md
50+
- name: Examples
51+
items:
52+
- name: Manage a key
53+
href: Microsoft/Windows/Registry/examples/manage-a-registry-key.md
54+
- name: Manage a value
55+
href: Microsoft/Windows/Registry/examples/manage-a-registry-value.md
56+
- name: Configure keys and values
57+
href: Microsoft/Windows/Registry/examples/configure-registry-keys-and-values.md
58+
- name: Microsoft.Windows/WindowsPowerShell
59+
items:
60+
- name: DSC resource
61+
href: Microsoft/Windows/WindowsPowerShell/index.md
62+
- name: Examples
63+
items:
64+
- name: Manage a Windows service
65+
href: Microsoft/Windows/WindowsPowerShell/examples/manage-a-windows-service.md
66+
- name: Microsoft.Windows/WMI
67+
items:
68+
- name: DSC resource
69+
href: Microsoft/Windows/WMI/index.md
70+
- name: Examples
71+
items:
72+
- name: Query operating system
73+
href: Microsoft/Windows/WMI/examples/query-operating-system-info.md
74+
- name: Query filtered disk
75+
href: Microsoft/Windows/WMI/examples/query-filtered-disk-info.md

‎dsc/docs-conceptual/dsc-3.0/reference/schemas/toc.yml‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
items:
2+
- name: Overview
3+
href: overview.md
4+
- name: Schema URIs
5+
href: schema-uris.md
6+
- name: dsc command outputs
7+
items:
8+
- name: dsc config command outputs
9+
items:
10+
- name: dsc config get output
11+
href: outputs/config/get.md
12+
- name: dsc config set output
13+
href: outputs/config/set.md
14+
- name: dsc config test output
15+
href: outputs/config/test.md
16+
- name: dsc extension command outputs
17+
items:
18+
- name: dsc extension list output
19+
href: outputs/extension/list.md
20+
- name: dsc resource command outputs
21+
items:
22+
- name: dsc resource get output
23+
href: outputs/resource/get.md
24+
- name: dsc resource list output
25+
href: outputs/resource/list.md
26+
- name: dsc resource set output
27+
href: outputs/resource/set.md
28+
- name: dsc resource test output
29+
href: outputs/resource/test.md
30+
- name: Configuration
31+
items:
32+
- name: Documents
33+
href: config/document.md
34+
- name: Document metadata
35+
href: config/metadata.md
36+
- name: Document parameters
37+
href: config/parameter.md
38+
- name: Resource instances
39+
href: config/resource.md
40+
- name: Functions
41+
items:
42+
- name: Overview
43+
href: config/functions/overview.md
44+
- name: add
45+
href: config/functions/add.md
46+
- name: base64
47+
href: config/functions/base64.md
48+
- name: concat
49+
href: config/functions/concat.md
50+
- name: createArray
51+
href: config/functions/createArray.md
52+
- name: div
53+
href: config/functions/div.md
54+
- name: envvar
55+
href: config/functions/envvar.md
56+
- name: equals
57+
href: config/functions/equals.md
58+
- name: format
59+
href: config/functions/format.md
60+
- name: if
61+
href: config/functions/if.md
62+
- name: int
63+
href: config/functions/int.md
64+
- name: max
65+
href: config/functions/max.md
66+
- name: min
67+
href: config/functions/min.md
68+
- name: mod
69+
href: config/functions/mod.md
70+
- name: mul
71+
href: config/functions/mul.md
72+
- name: parameters
73+
href: config/functions/parameters.md
74+
- name: reference
75+
href: config/functions/reference.md
76+
- name: resourceId
77+
href: config/functions/resourceId.md
78+
- name: sub
79+
href: config/functions/sub.md
80+
- name: variables
81+
href: config/functions/variables.md
82+
- name: Extension
83+
items:
84+
- name: Manifests
85+
items:
86+
- name: Root
87+
href: extension/manifest/root.md
88+
- name: Discover property
89+
href: extension/manifest/discover.md
90+
- name: Expected stdout
91+
items:
92+
- name: Discover operation stdout
93+
href: extension/stdout/discover.md
94+
- name: Resource
95+
items:
96+
- name: Manifests
97+
items:
98+
- name: Root
99+
href: resource/manifest/root.md
100+
- name: adapter command field
101+
href: resource/manifest/adapter.md
102+
- name: delete command field
103+
href: resource/manifest/delete.md
104+
- name: export command field
105+
href: resource/manifest/export.md
106+
- name: get command field
107+
href: resource/manifest/get.md
108+
- name: set command field
109+
href: resource/manifest/set.md
110+
- name: whatIf command field
111+
href: resource/manifest/whatIf.md
112+
- name: test command field
113+
href: resource/manifest/test.md
114+
- name: validate command field
115+
href: resource/manifest/validate.md
116+
- name: resolve command field
117+
href: resource/manifest/resolve.md
118+
- name: schema field
119+
items:
120+
- name: Command
121+
href: resource/manifest/schema/property.md
122+
- name: Embedded schemas
123+
href: resource/manifest/schema/embedded.md
124+
- name: Canonical resource properties
125+
items:
126+
- name: Overview
127+
href: resource/properties/overview.md
128+
- name: _ensure
129+
href: resource/properties/ensure.md
130+
- name: _exist
131+
href: resource/properties/exist.md
132+
- name: _inDesiredState
133+
href: resource/properties/inDesiredState.md
134+
- name: _purge
135+
href: resource/properties/purge.md
136+
- name: _rebootRequested
137+
href: resource/properties/rebootRequested.md
138+
- name: Metadata
139+
items:
140+
- name: Microsoft.DSC properties
141+
href: metadata/Microsoft.DSC/properties.md
142+
- name: Shared definitions
143+
items:
144+
- name: message
145+
href: definitions/message.md
146+
- name: resourceKind
147+
href: definitions/resourceKind.md
148+
- name: resourceType
149+
href: definitions/resourceType.md
150+
- name: Parameter dataTypes
151+
href: definitions/parameters/dataTypes.md

‎dsc/docs-conceptual/dsc-3.0/reference/toc.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
items:
2+
- name: DSC CLI
3+
href: cli/toc.yml
4+
- name: DSC JSON Schemas
5+
href: schemas/toc.yml
6+
- name: DSC resources
7+
href: resources/toc.yml
8+
- name: DSC tools
9+
href: tools/toc.yml

‎dsc/docs-conceptual/dsc-3.0/reference/tools/toc.yaml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
items:
2+
- name: Builtin commands
3+
items:
4+
- name: Overview
5+
href: builtin.md
6+
- name: osinfo
7+
href: osinfo.md
8+
- name: registry commandline
9+
items:
10+
- name: registry
11+
href: registry/index.md
12+
- name: registry query
13+
href: registry/query/index.md
14+
- name: registry set
15+
href: registry/set/index.md
16+
- name: registry remove
17+
href: registry/remove/index.md
18+
- name: registry find
19+
href: registry/find/index.md
20+
- name: registry config subcommands
21+
items:
22+
- name: registry config
23+
href: registry/config/index.md
24+
- name: registry config get
25+
href: registry/config/get.md
26+
- name: registry config set
27+
href: registry/config/set.md
28+
- name: registry config delete
29+
href: registry/config/delete.md
30+
- name: registry schema
31+
href: registry/schema/index.md

0 commit comments

Comments
 (0)