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

Suggestion: Automatically add a Table of Contents in the Home.md on build containing all the MOF-, class-, and composite-based resources #102

Open
johlju opened this issue Sep 18, 2021 · 2 comments
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.

Comments

@johlju
Copy link
Member

johlju commented Sep 18, 2021

Details of the scenario you tried and the problem that is occurring

Suggest automatically adding a Table of Contents o the Home.md during build. But only if the Home.md exist in WikiSource and have the correct placeholder.

Steps to reproduce the problem

n/a

Expected behavior

Home.md should have a ToC for quick reference.

Current behavior

No ToC anywhere, unless manually created and maintained by a contributors.

Suggested solution to the issue

Home.md should automatically update a ToC in the Home.md with the name of the resource and the description that can be found in the resource's README.md. The resource name should link to the correct resource wiki page.

The operating system the target node is running

n/a

Version and build of PowerShell the target node is running

n/a

Version of the module that was used

n/a

@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Sep 18, 2021
@johlju
Copy link
Member Author

johlju commented Sep 18, 2021

In MOF-resources it possible to add the following in each schema to help get the description 🤔 See exmaple in xMsiPackage resource in xPSDesiredStateConfiguration.

[Description("Provides a mechanism to install and uninstall .msi packages.") : Amended,AMENDMENT, LOCALE("MS_409")]

@PlagueHO
Copy link
Member

Great idea @johlju - didn't think of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Development

No branches or pull requests

2 participants