doc(reference): Generate documentation for policies #848
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We will generate then the documentation too, so split the names.
This is the internal recursive function to create documentation from a md template, one each page, for each documentation policy. Categories are sorted into folders, and both of them are split between Computer and User policies.
Those tests are similar to the ones for expandedCategoriesToADMX
Those are similar to the ones from expandedCategoriesToADMX.
This collects any policies and then call our generation code.
High level tests, similar to GenerateAD tests, to collect and bootstrap documentation generation.
Accompagning fixutres and golden files for generation policy documentation code.
This new command generate policy documentation reference in destination directory.
Those elements will expand to locate the registry key for the admin.
Do not use title for metadata/range/valid values. Otherwise, when listing them in the toc, we will always end up with them listed at the same level than the other elements (subdirectories/subsections).
This includes existing retitle and path refiltering.
didrocks
force-pushed
the
documentation_for_policies
branch
from
28f9af9
to
c5d9e33
Compare
jibel
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expand admxgen to generate documentation for policies.
This allows to create the necessary elements to dump all reference documentation in a given directory.
Those are formed from a template, when collecting supported referenced key.
UDENG-1039