Commit aa89bbe
📖 [Docs]: Process-PSModule documentation is now organized by task (#448)
The Process-PSModule documentation now leads with how to use the
pipeline. Getting started, guides, reference, and specification are
separate sections, so someone looking up a setting or wiring up their
first module no longer has to read the specification and design first.
## New: A guided path from template to first release
Getting started is now a walkthrough rather than a single page of
bullets. It covers creating the repository from the template,
configuring GitHub Pages and the PowerShell Gallery API key, adding the
caller workflow and settings file, and then opening the first pull
request and applying a version label. Bootstrapping a brand-new module
with an integration branch sits alongside it.
## New: Guides for the things people actually do
Seven task-oriented pages cover calling the workflow, configuring the
pipeline with worked examples, structuring a module, writing module
tests, skipping individual framework tests, versioning and releases, and
validating a change before review. Writing module tests is new — test
discovery rules, the `BeforeAll.ps1` and `AfterAll.ps1` phases, and how
to share expensive infrastructure across the platform matrix were
previously buried inside the pipeline-stages page.
## Changed: Documentation is grouped by what you are trying to do
The section was a flat list of 15 sibling pages ordered specification,
design, usage. It is now four ordered sections:
| Section | Purpose |
| --- | --- |
| Get started | Create a repository, configure it, ship a first release
|
| Guides | Task-oriented deep dives into the pipeline's functionality |
| Reference | Exact contracts — settings, workflow inputs, stages,
matrices, test IDs |
| Specification | Spec, design, and principles, for maintainers of the
pipeline itself |
The specification and design are still published, just last, since few
readers need them to use the pipeline.
## Changed: Every fact has one home
The scenario matrix, the version-label mapping, the framework test IDs,
the runtime settings contract, the repository setup steps, and the
dependency list were each documented in two or three places. Each now
lives on one page and is linked from the others, so they can no longer
drift apart. The landing page also no longer prints the same page-index
table twice.
## Changed: Pointer-only pages are gone
The `PowerShell`, `Solutions`, and `Style-Guides` sections contained
nothing but links to MSXOrg docs. They are removed and the pages that
referenced them now link straight to the canonical MSX standards,
removing a hop.
---
<details>
<summary>Technical details</summary>
- All page moves use `git mv`, so file history follows the content.
- Merges and splits: `index.md` + `workflow-overview.md` → one landing
page; `module-anatomy.md` folded into
`guides/structuring-your-module.md`; the `build-test-pack-publish.md`
stub replaced by `guides/versioning-and-releases.md`; `usage.md` split
into `guides/calling-the-workflow.md` + `reference/workflow-inputs.md`;
`configuration.md` split into `guides/configuring-the-pipeline.md` +
`reference/settings.md`; test-authoring content extracted from
`pipeline-stages.md` into `guides/writing-module-tests.md`.
- New reference pages: `scenario-matrix.md`, `framework-test-ids.md`,
`dependencies.md`, plus a `specification/index.md` section landing page.
- `design.md` documented `.github/PSModule.yml` with `Enabled:` keys
while the real authorable contract uses `Skip:`. Rather than restate the
contract, it now links to `reference/settings.md`, which removes the
contradiction.
- `design.md` also carried its own copy of the runtime `Settings` table
that had drifted from the one in `pipeline-stages.md`
(`Test.Module.Enabled` vs the actual
`BeforeAllEnabled`/`MainEnabled`/`AfterAllEnabled`). It now links to the
pipeline-stages copy.
- Linter configuration consolidated: the duplicated
`docs/.github/linters/*` set is removed in favour of the
repository-level `.github/linters/*`, with the codespell, markdownlint,
and PSScriptAnalyzer profiles updated to cover the docs corpus.
- `docs/zensical.toml` nav rewritten to the four-section hierarchy.
`navigation.indexes` is already enabled, so each section index is
clickable and there are no dead nav nodes.
- Validation performed: every relative markdown link across
`docs/content` resolves; every in-tree heading anchor referenced by a
link exists; every `zensical.toml` nav entry points at an existing file.
This also clears two pre-existing broken links to
`../PowerShell/Standard/index.md` in `Module-Types.md` and
`Standards.md`.
- No callable workflow contract changed.
`.github/workflows/workflow.yml` and the reusable sub-workflows are
untouched; only the repository-internal `Docs.yml` and linter configs
are modified, so there is no release impact for consumers.
- Delivery leaf: this pull request has no scoped closing Task or Bug. It
needs one under #423 before it satisfies the
Definition of Ready for Review.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- #423
</details>
---------
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>1 parent d1e2feb commit aa89bbe
46 files changed
Lines changed: 1228 additions & 1655 deletions
File tree
- .github
- linters
- workflows
- docs
- .github/linters
- content
- Modules
- Process-PSModule
- get-started
- guides
- reference
- specification
- PowerShell
- DSC
- FunctionApps
- Scripts
- Standard
- Solutions
- Style-Guides
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
| 16 | + | |
16 | 17 | | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
27 | | - | |
| 28 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
This file was deleted.
This file was deleted.
This file was deleted.
0 commit comments