Skip to content

⚙️ [Maintenance]: Showcase both docs section landing-page conventions (index.md + folder-named)#27

Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
test/section-landing-pages
Open

⚙️ [Maintenance]: Showcase both docs section landing-page conventions (index.md + folder-named)#27
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
test/section-landing-pages

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

The template now includes two example command groups that demonstrate both ways to give a group its documentation section landing page. IndexSection uses an index.md file, and NamedSection uses 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 by index.md, with Get-IndexSectionTest.
  • NamedSection/ — landing page provided by the folder-named NamedSection.md, with Get-NamedSectionTest.

Technical Details

  • Added src/functions/public/IndexSection/{index.md, Get-IndexSectionTest.ps1} and src/functions/public/NamedSection/{NamedSection.md, Get-NamedSectionTest.ps1}; both functions mirror the existing *-PSModuleTest shape and return Hello, <Name>!.
  • tests/PSModuleTest.Tests.ps1: added It blocks for Get-IndexSectionTest and Get-NamedSectionTest.
  • No workflow change required: main already 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.
  • Local checks: both functions dot-source and return the expected output; PSScriptAnalyzer (repo profile) reports no findings on the new files.

…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).
@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

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.

1 participant