⚙️ [Maintenance]: Showcase both docs section landing-page conventions (index.md + folder-named)#27
Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Open
Conversation
…r-named) Add two example command groups exercising both overview-page conventions: IndexSection uses index.md as its section landing page, NamedSection uses a folder-named NamedSection.md. Adds Get-IndexSectionTest and Get-NamedSectionTest plus their Pester tests. Template already runs Process-PSModule v6.1.1 (#26).
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
This file contains hidden or 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
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.
The template now includes two example command groups that demonstrate both ways to give a group its documentation section landing page.
IndexSectionuses anindex.mdfile, andNamedSectionuses a file named after its folder (NamedSection.md). After the docs build, each group's overview page is shown as its section landing page in the navigation on GitHub Pages — the behavior delivered by Process-PSModule v6.1.1, which this template already runs.New: Two example command groups showcasing both landing-page conventions
IndexSection/— landing page provided byindex.md, withGet-IndexSectionTest.NamedSection/— landing page provided by the folder-namedNamedSection.md, withGet-NamedSectionTest.Technical Details
src/functions/public/IndexSection/{index.md, Get-IndexSectionTest.ps1}andsrc/functions/public/NamedSection/{NamedSection.md, Get-NamedSectionTest.ps1}; both functions mirror the existing*-PSModuleTestshape and returnHello, <Name>!.tests/PSModuleTest.Tests.ps1: addedItblocks forGet-IndexSectionTestandGet-NamedSectionTest.mainalready pins Process-PSModule v6.1.1 (⚙️ [Maintenance]: Adopt Process-PSModule v6.1.1 and showcase test data (secret + variable) in tests #26), which ships the section-landing behavior via Document-PSModule v1.0.18.