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.

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

Doc generator #126

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

Gijsreyn
Copy link
Contributor

@Gijsreyn Gijsreyn commented Nov 8, 2024


This pull request addresses an initial setup to start generating documentation for all classes. The end goal of the doc generator:

  • Ability to generate all documentation files on the fly in a standardized format
  • Should validate if modules have been modified, the documentation files are also always up to date

Note

The static methods came from the idea on the DSC discussion by Mikey. This is far from crystalized, but an attempt to kickstart the idea for resource authors in this repository.
I talked with Jim Truher also on class documentation, but there isn't anything available (yet). In the current commit, you can also see the attempt to dynamically generate docs using the Microsoft.PowerShell.PlatyPS module. However, there are to many properties outputted when converting for Markdown. That's why I choose the way to build it up using separate functions.

Microsoft Reviewers: Open in CodeFlow

@Gijsreyn
Copy link
Contributor Author

Gijsreyn commented Nov 8, 2024

@denelon Curious to your thoughts.

@denelon
Copy link
Contributor

denelon commented Nov 11, 2024

I'd like @ryfu-msft to take a look. I think the idea is sound, I just want to make sure we're not departing too far away from making it easy to add new resources and subsequently have the ability to move them to their own new "home". For the Microsoft modules they might stay here or move to another repository, and for the non-Microsoft resources, we might want them to move to either the DSC Community or to live with the product they configure.

@Gijsreyn Gijsreyn force-pushed the generate-resource-docs branch from 7b7f855 to db2ac3a Compare November 14, 2024 14:38
@Gijsreyn Gijsreyn force-pushed the generate-resource-docs branch from db2ac3a to d23e3d2 Compare December 7, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants