Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(reference): Generate documentation for policies #848

Merged
merged 11 commits into from
Nov 16, 2023
Merged

doc(reference): Generate documentation for policies #848

merged 11 commits into from
Nov 16, 2023

Commits on Nov 15, 2023

  1. Split Generate from Generate admx/adml 

    We will generate then the documentation too, so split the names.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    48679ef View commit details
    Browse the repository at this point in the history

  2. Implement generation reference documentation for policy 

    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.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    bf80a86 View commit details
    Browse the repository at this point in the history

  3. Tests for expandedCategoriesToMD 

    Those tests are similar to the ones for expandedCategoriesToADMX
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    271d18c View commit details
    Browse the repository at this point in the history

  4. Fixtures and golden assets for expandedCategoriesToMD tests 

    Those are similar to the ones from expandedCategoriesToADMX.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    ce96871 View commit details
    Browse the repository at this point in the history

  5. Entry point for generating policy documentation 

    This collects any policies and then call our generation code.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    0aabfe2 View commit details
    Browse the repository at this point in the history

  6. Tests for generation policy documentation 

    High level tests, similar to GenerateAD tests, to collect and bootstrap
documentation generation.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    2ddec9c View commit details
    Browse the repository at this point in the history

  7. Fixtures and golden files for generating policy documentation 

    Accompagning fixutres and golden files for generation policy
documentation code.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    38b6175 View commit details
    Browse the repository at this point in the history

  8. Add "doc" subcommand to admxgen 

    This new command generate policy documentation reference in destination
directory.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    c00794d View commit details
    Browse the repository at this point in the history

  9. Add key and location in metadata 

    Those elements will expand to locate the registry key for the admin.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    54bf36d View commit details
    Browse the repository at this point in the history

  10. Avoid making subsections as titles. 

    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).
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    d9e5821 View commit details
    Browse the repository at this point in the history

  11. Regenerate golden files 

    This includes existing retitle and path refiltering.
    @didrocks
    didrocks committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    c5d9e33 View commit details
    Browse the repository at this point in the history