Skip to content

Glossary definitions use direct evergreen prose - #567

Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
glossary-writing-alignment
Open

Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
glossary-writing-alignment

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

The glossary explains PSModule terms with direct en-US statements. The definitions distinguish integration, delivery, deployment, and REST interfaces. Abbreviation tooltips use consistent technical names. Contribution and search procedures remain direct instructions.

No consumer action is required. Page paths, heading anchors, front matter, abbreviation keys, versions, and example operations stay unchanged. This pull request changes guidance only; it does not change module, workflow, configuration, or site-generator behavior.

Changed: Glossary definitions state their meaning directly

The index states its reference purpose without a greeting or rhetorical question. Definitions use short descriptions with named subjects and active verbs. The API entry describes software communication without an unexplained GUI-specific use claim. CI/CD includes both meanings of CD, and the REST API entry distinguishes an interface from the REST architectural style.

The abbreviation include keeps all 50 keys in their original order. Five tooltip values change; the other 45 values stay byte-for-byte unchanged. The glossary retains MkDocs as a term without claiming that it builds this documentation site. It also retains Microsoft's exact Long-Term Servicing name and the existing PowerShell 7.5 support link.

Technical details

Source and comparison identities

  • Repository: PSModule/Process-PSModule.
  • Scoped base: 64ffb1d87f86bd5d487891fdb140b78385a00531.
  • Pushed head: e0dd865ff0973a0eef3b3a75a0fac81ff1541592.
  • Scope: 20 Dictionary pages and docs\includes\abbreviations.md; 48 insertions and 40 deletions.
  • Four small commits: 5f9d0d6e69fd52b838228a99ffaa8420ede63f9e, 88b9f46ab0d7ea8739db243ab1f374795c19b944, 1d1db67f2956d035a36b140994d84cf1f625a105, and e0dd865ff0973a0eef3b3a75a0fac81ff1541592.

The draft opened after the first coherent commit. This is a scoped documentation record, not a versioned-artifact release record. The documentation route in .github\workflows\Docs.yml runs lint and a site build for pull requests. No release decision block or release:* label is added.

Pinned writing baseline

The review uses MSXOrg/docs commit 1b0d4893c8fefabe604d04393068a8ff6f848082, not moving main:

  • Documentation Model: stable facts belong in the reference; per-change evidence belongs in the delivery issue and PR.
  • Natural Language: en-US, direct descriptions, present tense, precise technical terms, and imperative procedures.
  • Writing Guide: consult official STE guidance and preserve meaning, exact identifiers, examples, and normative force.
  • Markdown and Documentation: sentence-case headings, stable links, native syntax, and concise reference content.
  • Reference template: lead with the lookup purpose. The existing glossary layout stays intact.
  • Task format, Commit Conventions, and PR Format: test-first evidence, small commits, and a guidance-specific result.

The official STE overview, FAQ, and ASD-STE100 Issue 9 were available. The local PDF MD5, 9c720341c350ed77943b2c73d01c716f, matches the official record.

Manual review covers technical nouns, en-US spelling, present-tense descriptions, active voice, short complete sentences, logical order, and direct instructions. Applicable rule references are 1.1-1.14, 3.2, 3.5-3.6, 4.1-4.2, and 6.1-6.6. Technical names, including YAML Ain't Markup Language, retain their exact form. No manual text or extraction is republished. This review does not claim full STE conformance. Lint, rendering checks, and counts verify specific properties; they do not prove language conformance.

Full changed-path inventory and before/after evidence

All 32 Dictionary files and the abbreviation include received a full manual read before edits. The issue records original text and expected properties before implementation. This table lists every changed path.

Changed path Concrete original text Delivered text or property Technical source
docs\content\Dictionary\api.md APIs "are used when programming graphical user interface (GUI) components." "An Application Programming Interface (API) is a set of rules for communication between software components." The GitHub repository, issue, and pull request script example remains. MDN API glossary; GitHub REST API
docs\content\Dictionary\azure-functions.md "without having to explicitly provision or manage infrastructure" "Azure Functions runs code in response to events. Serverless hosting options manage the infrastructure that runs the code." The infrastructure statement applies to serverless hosting, not every hosting plan. Azure Functions overview and hosting options
docs\content\Dictionary\branch.md "a parallel version of a repository that diverges from the main working project" "In version control, a branch is an independent line of development. In Git, it points to a commit in a repository." The feature-branch example retains the merge into the main branch. Pro Git: branches
docs\content\Dictionary\ci-cd.md "after which automated builds and tests are run" defines only integration. CI uses automated builds and tests for code integration. "Continuous Delivery keeps tested changes ready for production deployment. Continuous Deployment automatically deploys each change that passes the pipeline to production." GitLab CI/CD concepts; GitHub Actions concepts
docs\content\Dictionary\cmdlet.md "is designed to perform a specific function" "A cmdlet is a lightweight PowerShell command that performs a specific task and follows the verb-noun naming convention." Get-Process, Set-Location, and New-Item are unchanged. Microsoft cmdlet overview
docs\content\Dictionary\docker.md "developing, shipping, and running applications using containerization technology" "Docker is a platform with tools to develop, distribute, and run applications in containers." Docker overview
docs\content\Dictionary\github-actions.md "allows you to automate your ..." and "when a pull request is created" "GitHub Actions is GitHub's CI/CD platform. It automates build, test, and deployment tasks in a pipeline." The example names the contributor who creates the pull request. GitHub Actions concepts
docs\content\Dictionary\github.md "lets you and others work together on projects from anywhere" "GitHub is a web-based platform for version control and collaboration." GitHub and Git
docs\content\Dictionary\index.md "Welcome to the PSModule Glossary"; "Common terms you might encounter:"; "Found a term that should be added ... ?" "This glossary is a reference for terms, concepts, and technologies in PSModule projects and documentation." "The quick reference lists common PSModule terms." "To add a term or correct a definition, create an issue or submit a pull request." Search remains an imperative. The CI/CD quick reference includes delivery and deployment. Pinned Documentation Model, Natural Language, Markdown, and reference template; GitLab CI/CD concepts
docs\content\Dictionary\lts.md "Long-Term Servicing (LTS)." and "For more info visit:" "PowerShell Long-Term Servicing (LTS) releases use .NET LTS releases." "See PowerShell Support Lifecycle for support policies and end-of-support dates." The name, heading, anchor, and view=powershell-7.5 URL are unchanged. PowerShell support lifecycle explicitly uses Long Term Servicing
docs\content\Dictionary\markdown.md "designed to be converted to HTML and many other formats" "Markdown is a lightweight markup language that uses plain text syntax. Tools convert Markdown documents to HTML and other formats." Markdown author documentation; Pandoc format conversion
docs\content\Dictionary\mkdocs.md "A fast, simple static site generator that's geared towards building project documentation" "MkDocs is a static site generator for project documentation. It builds sites from Markdown files." MkDocs
docs\content\Dictionary\pipeline.md "reliably and efficiently compile, build, and deploy" "A pipeline is a series of automated processes that developers and DevOps teams use to compile, build, and deploy code." Unsupported performance qualifiers are removed. Azure Pipelines overview; GitHub Actions concepts
docs\content\Dictionary\powershell.md "consisting of a command-line shell and the associated scripting language" "PowerShell is a task automation and configuration management framework from Microsoft. It includes a command-line shell and a scripting language." What is PowerShell?
docs\content\Dictionary\pull-request.md "where changes are proposed and reviewed before being merged" "A Pull Request (PR) proposes changes to a software project for review before a merge into the codebase." GitHub pull requests
docs\content\Dictionary\rest-api.md The API is described as "An architectural style". "A REST API is an interface for a web service that follows the Representational State Transfer (REST) architectural style." The existing GET, PUT, POST, and DELETE names remain as HTTP method examples. Fielding, chapter 5; RFC 9110 methods
docs\content\Dictionary\semantic-versioning.md "where each part is incremented based on the type of changes made" "Semantic Versioning (SemVer) uses the three-part version format MAJOR.MINOR.PATCH. The version number indicates whether a change affects compatibility, adds functionality, or fixes a bug." The 1.2.3 example is unchanged. Semantic Versioning
docs\content\Dictionary\template.md "can be used as a starting point for creating new files" "A template gives a format or structure for new files, projects, or configurations." Existing definition; pinned Natural Language and reference template; no new technical claim
docs\content\Dictionary\workflow.md "execute in response to specific events or triggers" and "code is pushed" "A workflow is an automated process that runs in response to an event or trigger." The example keeps tests on each code push and names the contributor. GitHub Actions workflows
docs\content\Dictionary\yaml.md "commonly used for configuration files and data exchange"; workflows "are defined using YAML files" "YAML Ain't Markup Language (YAML) is a human-readable data serialization standard. Applications use YAML for configuration files and data exchange." "GitHub Actions workflows use YAML files." YAML specification; GitHub Actions concepts
docs\includes\abbreviations.md Five original tooltip values below. Five source-backed values below; all 50 keys, their order, and the other 45 values are unchanged. Sources in the next table

Exact tooltip changes

Preserved key Before After Technical source
CI/CD Continuous Integration/Continuous Deployment Continuous Integration with Continuous Delivery or Continuous Deployment GitLab CI/CD
Docker Platform for developing, shipping, and running applications in containers Platform with tools to develop, distribute, and run applications in containers Docker overview
HTML Hyper Text Markup Language HyperText Markup Language W3C HTML definition
pwsh PowerShell Core (also known as PowerShell 7) PowerShell 7 command-line executable Microsoft about_Pwsh; the executable is not a product-name alias
XML eXtensible Markup Language Extensible Markup Language W3C XML

Full reviewed no-change inventory

These 12 assigned pages received a full manual review and remain byte-for-byte identical to the base. The short lookup definitions already identify their concepts without change history or conversational introductions. The review does not manufacture changes merely to rewrite every definition.

No-change path Reason
docs\content\Dictionary\azure.md The cloud-platform definition and service categories are direct and specific; the related links remain useful.
docs\content\Dictionary\azure-devops.md The lookup phrase identifies Microsoft's tools and their version-control, build, and project-management purposes.
docs\content\Dictionary\build-pipeline.md The definition directly names compilation, tests, packaging, and deployable artifacts.
docs\content\Dictionary\container.md The definition names the application package and its runtime dependencies; no procedural or time-bound prose needs replacement.
docs\content\Dictionary\devops.md The definition states the development/operations practice and its purpose; Dev and Ops remain exact terms.
docs\content\Dictionary\git.md The distributed version-control definition is short and precise.
docs\content\Dictionary\module.md The PowerShell-specific definition already names the member categories; preserve the exact list.
docs\content\Dictionary\repository.md The definition retains the distinction between package storage and version-control files/history instead of claiming that every repository has one form.
docs\content\Dictionary\static-site-generator.md The definition directly identifies static HTML output, source data, and templates.
docs\content\Dictionary\testing.md The definition already identifies requirements and correct operation as the purpose of testing.
docs\content\Dictionary\version-control.md The active description records file changes and the ability to recall earlier versions; time is part of the concept, not release history.
docs\content\Dictionary\virtual-environment.md The concise definition already states package/dependency isolation from the global installation.

The other 45 abbreviation values also have a no-change result. They are short technical-name expansions or lookup phrases. Their exact original bytes are retained. The renderer verifies every key and value, including these no-change entries.

Excluded paths and compatibility

No assigned file is excluded from review. The two inventories above account for all 33 assigned files. Every other repository path is excluded from edits. This includes README.md, AGENTS.md, docs\zensical.toml, docs\content\index.md and its generated index region, docs\content\Modules\**, other docs\content sections, other includes, .github\**, tests, native help, source code, and dependency manifests. Existing framework and release proposals keep their own paths.

All 31 front-matter blocks across 32 pages, all page paths, all source link-target sequences, and all rendered heading anchors are unchanged. Dictionary\index.md has no YAML front matter. Only the case of the index's Table of contents and Quick reference headings changes; their anchors are still table-of-contents and quick-reference. No link repair is required. Cmdlet examples, the semantic-version example 1.2.3, the PowerShell 7 tooltip version, and the existing PowerShell 7.5 URL stay intact. Contribution and search instructions remain imperative. No requirement or normative keyword is strengthened or weakened.

Open PR file ownership was rechecked before each of the four commits. No other open PR owns an assigned path.

Validation commands and results

The existing repository tools were already available. No tool or repository dependency was installed. Versions: Python 3.14.10, Zensical 0.0.50, Markdown 3.10.2, markdownlint-cli2 0.24.0, and markdownlint 0.42.0.

The Windows lint command enumerates actual files instead of relying on wildcard expansion:

$files = @(Get-ChildItem -LiteralPath .\docs\content\Dictionary -Filter '*.md' -File | Select-Object -ExpandProperty FullName)
$files += (Resolve-Path -LiteralPath .\docs\includes\abbreviations.md).Path
npx --no-install markdownlint-cli2 --config .github\linters\.markdown-lint.yml @files

Result: 33 files, 0 issues, before edits and after each coherent change. The first wildcard probe covered only the include; it was rejected as glossary evidence and replaced with the explicit 33-file command.

The existing site check runs in complete local copies of docs under session artifacts, so its cache and generated output do not modify an excluded repository path:

zensical build --clean
zensical build --clean --strict

Result: "No issues found" for both commands on both the unchanged base and the final committed documentation. The command matches .github\workflows\Docs.yml; strict mode adds the builder's warning gate.

Check Result
git diff --check 64ffb1d87f86bd5d487891fdb140b78385a00531..HEAD Pass; the committed diff has only the 21 listed paths.
Full manual review against the pinned sources and technical sources All 33 assigned files reviewed; 21 changed and 12 unchanged.
Front matter, source link targets, exact examples, and no-change byte comparison All 31 front-matter blocks across 32 pages and all link-target sequences are unchanged; the 12 no-change files and original code/version examples are exact.
Python standard-library HTMLParser inspection of the existing site output All 32 Dictionary pages have the same rendered heading anchors as the base; 96 internal article links resolve, including 35 fragment links. The rendered index/API acceptance examples pass.
Existing markdown.markdown renderer with the project's abbr and pymdownx.snippets settings All 50 keys produce the exact expected HTML tooltip; key order is unchanged, and 45 tooltip values match the original bytes. The probe is in memory, not a new repository page or checker.
Invoke-WebRequest -Method Head for the two authored external content URLs The GitHub issue-list URL and the unchanged versioned PowerShell lifecycle URL both return HTTP 200. Generated edit/source controls retain their original targets.
git status --porcelain=v1 Clean after the four pushed commits.

No Pester or runtime test suite is needed for this prose-only diff. The documentation build and Markdown checks cover the changed surface without adding an enforcement script.

The documentation CI run completes successfully at the exact final head. Build, Lint, Markdown, natural-language, and spelling checks pass. The repository linter also passes. All reported PR checks are successful except the expected Publish skip on a pull request.

Standards and framework alignment

Changed surface Standards checked Framework docs checked Result
docs\content\Dictionary\*.md Pinned Documentation Model, reference template, Natural Language, Writing Guide, Markdown, Documentation; official STE sources Repository README; existing glossary layout; canonical Microsoft, GitHub, Git, Docker, YAML, Markdown, and SemVer sources Fixed in this PR
docs\includes\abbreviations.md Pinned terminology and reference rules; exact technical names and keys Existing abbr and snippet configuration in docs\zensical.toml; canonical terminology sources above Fixed in this PR

The delivery issue carries the test-first examples and plan progress. The scope check searched open issues for glossary, abbreviation, and Dictionary. Other documentation leaves, #556, #557, and #559, retain their separate paths. #509 concerns migrated links; the base already passes the strict build with the installed builder, so this diff does not claim to resolve that issue. Only the assigned delivery leaf has a closing reference.

The pull request remains draft and is assigned to its author. Copilot review was explicitly requested with gh pr edit 567 --repo PSModule/Process-PSModule --add-reviewer '@copilot'. No merge, ready-for-review transition, auto-merge, or Agent merge is requested.

Final review and CI status: Copilot approves head e0dd865ff0973a0eef3b3a75a0fac81ff1541592 in review 5768355755, submitted at 2026-11-04T12:36:44Z, with no inline comments or active review issues. CI passes. The draft state is intentional. No implementation blocker, unavailable source, or path conflict remains. Human review and any later readiness or merge decision remain outside this delivery.

Related references

@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
CSS Pass ✅
CSS_PRETTIER Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER 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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

No active review issues remain for these glossary wording and definition updates.

No open issues 🎉

What changed in this PR

This documentation-only PR makes the PSModule glossary more direct and evergreen. It preserves page paths, navigation targets, and contribution and search procedures without changing workflow, module, or configuration behavior.

Changes:

  • Rewrites glossary definitions and examples as concise, direct statements.
  • Clarifies technical concepts, including APIs, CI/CD, Git branches, and PowerShell LTS.
  • Updates abbreviation descriptions and simplifies index guidance.
File Description
docs/​includes/​abbreviations.md Refines CI/CD, Docker, HTML, pwsh, and XML descriptions.
docs/​content/​Dictionary/​yaml.md Simplifies the YAML definition and workflow example.
docs/​content/​Dictionary/​workflow.md Uses direct wording for automated workflows.
docs/​content/​Dictionary/​template.md Shortens the template definition.
docs/​content/​Dictionary/​semantic-versioning.md Explains version format and change significance.
docs/​content/​Dictionary/​rest-api.md Distinguishes REST interfaces from HTTP resource operations.
docs/​content/​Dictionary/​pull-request.md States the proposal and review purpose directly.
docs/​content/​Dictionary/​powershell.md Separates the framework definition from its components.
docs/​content/​Dictionary/​pipeline.md Removes subjective claims from the pipeline definition.
docs/​content/​Dictionary/​mkdocs.md Describes documentation generation without promotional wording.
docs/​content/​Dictionary/​markdown.md Clarifies syntax and document conversion.
docs/​content/​Dictionary/​lts.md Adds the .NET LTS relationship and clarifies lifecycle guidance.
docs/​content/​Dictionary/​index.md Simplifies reference, contribution, and search guidance.
docs/​content/​Dictionary/​github.md Condenses the platform definition.
docs/​content/​Dictionary/​github-actions.md Clarifies automation tasks and the pull request example.
docs/​content/​Dictionary/​docker.md Describes container tooling in direct terms.
docs/​content/​Dictionary/​cmdlet.md Simplifies the task and naming description.
docs/​content/​Dictionary/​ci-cd.md Distinguishes integration, delivery, and deployment.
docs/​content/​Dictionary/​branch.md Defines branches as development lines and Git commit pointers.
docs/​content/​Dictionary/​azure-functions.md Clarifies event-driven execution and serverless hosting.
docs/​content/​Dictionary/​api.md Replaces the GUI-specific claim with a communication definition.

Review effort: Balanced

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review November 4, 2026 14:43

This branch has not been deployed

No deployments
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.

[documentation-writing-alignment] State glossary definitions in clear evergreen prose

2 participants