Skip to content

Commit a5d55eb

Browse files
πŸ“– [Docs]: Remove Ways of Working (now maintained in MSXOrg/docs) (#59)
The Ways of Working documentation now lives in the organization-wide docs site, [MSXOrg/docs](https://msxorg.github.io/docs/Ways-of-Working/), which is the authoritative, generalized, and expanded source. This removes the duplicated copies from the PSModule docs site so there is a single source of truth. As the org site states: "PSModule inherits the Coding Standards and Ways of Working from this site and adds only what is specific to the framework." ## Removed: Ways of Working section The **Ways of Working** navigation section and its 14 pages are removed from the PSModule docs site. Readers now find this material β€” generalized across the organization and expanded with additional pages β€” on the MSX docs site: - [Ways of Working on MSXOrg/docs](https://msxorg.github.io/docs/Ways-of-Working/) Every removed page (Workflow, Principles, Goal-Setting, Issue Format, Issue Hierarchy, PR Format, Commit Conventions, Review Etiquette, README-Driven Context, Git Worktrees, Continuous Practices, Development/Engineering Practices, DevOps Reference, and the section index) has an equivalent-or-superset counterpart on the MSX site, so no content is lost. ## Changed: cross-links now point to the org site Links that previously referenced these local pages now point to the MSX docs site: - Home page "objectives and initiatives" β†’ MSX Goal-Setting - "Infusing GitHub with PowerShell" mission and initiatives links β†’ MSX Goal-Setting - PowerShell standards "Principles" reference β†’ MSX Principles ## Technical Details - Deleted `src/docs/Ways-of-Working/` (14 files, βˆ’1985 lines). - Removed the `Ways of Working` block from the `nav` array in `src/zensical.toml`; the file still parses as valid TOML and every remaining nav target resolves on disk. - Repointed the 4 inbound links in `src/docs/index.md`, `src/docs/Solutions/Infusing-GitHub-with-PowerShell.md`, and `src/docs/PowerShell/Standard/index.md` to the published MSX URLs; each target was verified to return HTTP 200. - **Scope note:** This PR removes only the Ways of Working section, which was a near-verbatim move to MSXOrg. The coding-standards content (Style Guides, `PowerShell/Standard`, GitHub Actions Standards) and the Dictionary are intentionally **kept** β€” the PSModule versions are substantially more detailed (~2000 lines vs ~800 on MSX), so removing them would lose content rather than de-duplicate. If MSX should become authoritative for those as well, that is a good follow-up once the detail is mirrored there.
1 parent 5e217a1 commit a5d55eb

18 files changed

Lines changed: 4 additions & 1985 deletions

β€Žsrc/docs/PowerShell/Standard/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PowerShell standards
22

33
These standards apply to all PowerShell files across PSModule repositories. They implement the
4-
engineering principles defined in [Principles](../../Ways-of-Working/Principles.md) β€” specifically
4+
engineering principles defined in [Principles](https://msxorg.github.io/docs/Ways-of-Working/Principles/) β€” specifically
55
*Clean Code*, *Make change easy*, *Shift Left*, and *Build for the modern engineer*.
66

77
Each standard states the practice, why it matters to us, and how to apply it.

β€Žsrc/docs/Solutions/Infusing-GitHub-with-PowerShell.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Infusing GitHub with PowerShell
22

3-
*Infuse GitHub with PowerShell* is the [mission](../Ways-of-Working/Goal-Setting.md) of the PSModule organization. GitHub gives mainstream languages β€” JavaScript, Python, .NET, Go β€” a rich, built-in developer experience: dependency updates, security scanning, package registries, setup actions, and a first-party API client. PowerShell is a first-class automation language, but on the GitHub platform it is treated as a second-class citizen. This initiative closes that gap.
3+
*Infuse GitHub with PowerShell* is the [mission](https://msxorg.github.io/docs/Ways-of-Working/Goal-Setting/) of the PSModule organization. GitHub gives mainstream languages β€” JavaScript, Python, .NET, Go β€” a rich, built-in developer experience: dependency updates, security scanning, package registries, setup actions, and a first-party API client. PowerShell is a first-class automation language, but on the GitHub platform it is treated as a second-class citizen. This initiative closes that gap.
44

55
We do it two ways: by **building** the PowerShell-native tooling the ecosystem is missing, and by **advocating** for the platform to support PowerShell where only the vendor can. This page describes the collection we have built and the capabilities we still want to make PowerShell-native.
66

@@ -108,4 +108,4 @@ The gaps split into two kinds of work, matching how we operate:
108108
- **Build it.** Where a public API exists, we close the gap ourselves with a module or action: SARIF upload from PSScriptAnalyzer, dependency submission for module manifests, module caching for `Install-PowerShell`, and attestations on published modules.
109109
- **Advocate for it.** Where only the vendor can deliver β€” a native Dependabot ecosystem, a PowerShell Gallery entry in the Advisory Database, CodeQL support, OIDC trusted publishing, and a first-class package registry β€” we raise it with GitHub, Microsoft, and the Gallery, and ship a working interim in the meantime.
110110

111-
New parity gaps and concrete bets are tracked as [initiatives](../Ways-of-Working/Goal-Setting.md) under the mission.
111+
New parity gaps and concrete bets are tracked as [initiatives](https://msxorg.github.io/docs/Ways-of-Working/Goal-Setting/) under the mission.

β€Žsrc/docs/Ways-of-Working/Commit-Conventions.mdβ€Ž

Lines changed: 0 additions & 59 deletions
This file was deleted.

β€Žsrc/docs/Ways-of-Working/Git-Worktrees.mdβ€Ž

Lines changed: 0 additions & 114 deletions
This file was deleted.

β€Žsrc/docs/Ways-of-Working/Goal-Setting.mdβ€Ž

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
Β (0)