📖 [Docs]: README pages now use the standard module landing-page format#15
Merged
Marius Storhaug (MariusStorhaug) merged 3 commits intoJul 7, 2026
Merged
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 5, 2026 23:32
View session
There was a problem hiding this comment.
Pull request overview
Updates the repository README to remove template-generated boilerplate and replace it with a short, repository-specific “placeholder/status” message, aligning documentation with the current scaffold state of the project.
Changes:
- Replaced template introduction text with a concise module description.
- Removed placeholder prerequisites/installation/usage/documentation sections.
- Added a “Status” section indicating the repo is currently a placeholder and simplified “Contributing”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:38
View session
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
added a commit
that referenced
this pull request
Jul 14, 2026
Confluence is now a working PowerShell module: connect to an Atlassian Confluence Cloud site once and manage pages, spaces, blog posts, folders, comments, labels, content properties, attachments, and restrictions as first-class PowerShell commands. This first version ports the generalized Confluence REST v2 client into the PSModule source layout and wires it to the Process-PSModule build. ## New: 41 Confluence commands Grouped by resource area: - **Auth** — `Connect-Confluence`, `Disconnect-Confluence`, `Get-ConfluenceContext` - **Config** — `Get-ConfluenceConfig`, `Set-ConfluenceConfig` - **API** — `Invoke-ConfluenceRestMethod` (the single generic REST entry point every command wraps) - **Spaces** — `Get-ConfluenceSpace`, `Get-ConfluenceSpacePermission`, `Get-ConfluenceSpaceProperty`, plus space administration: `New-ConfluenceSpace` (create), `Update-ConfluenceSpace` (partial update), `Set-ConfluenceSpace` (declarative create-or-replace), `Remove-ConfluenceSpace` (permanent, asynchronous delete) - **Site / Pages / BlogPosts / Folders / Comments / Labels / ContentProperties / Attachments / Restrictions / Users** — read/write commands per area; page edits use `Update-ConfluencePage` (renamed from `Set-ConfluencePage`, since it performs a partial update and the `Set` verb is reserved for declarative create-or-replace as in `Set-ConfluenceSpace`) Each command documents its required OAuth granular scope in its help, and errors surface Atlassian's `X-Failure-Category` (for example `FAILURE_CLIENT_SCOPE_CHECK`) so permission/scope failures are easy to spot. Every command's help links to its documentation page (`https://psmodule.io/Confluence/Functions/<Area>/<Command>/`) followed by the relevant Atlassian API reference. ## New: reusable connections via Context Credentials and module configuration persist through the [Context](https://github.com/PSModule/Context) module, declared via `#Requires` so the build records it as a manifest dependency. Connect once — the token is stored as a `SecureString`. Store multiple sites or accounts as named contexts and target any of them with `-Context`. ```powershell $token = Read-Host -AsSecureString Connect-Confluence -Site 'msxorg' -Username 'you@example.com' -Token $token -SpaceKey 'DOCS' $space = Get-ConfluenceSpace -Key 'DOCS' New-ConfluencePage -SpaceId $space.id -Title 'Release notes' -Body '<p>Hello</p>' ``` ## How it is built - One function per file under `src/functions/{public,private}`, grouped by resource area; module state in `src/variables/private`. - No `header.ps1` and no source `manifest.psd1` — the build generates the manifest, derives the module tags from the repository topics, and reads the `#Requires` (PowerShell 7.0 and Context) from the source. - Comment-based help follows the GitHub module style: indented sections, fenced examples, and a documentation-page `.LINK` first. - Examples (`Connecting`, `Pages`) and a credential-free surface test, plus a skipped integration scaffold that reads `CONFLUENCE_*` environment secrets. Tests require Pester 6.x. ## Tests and secrets No tenant-specific data is included — examples use generic placeholders. The integration tests are skipped unless connection details are provided through the repository's Actions secret and variables (`CONFLUENCE_SITE`, `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`, `CONFLUENCE_SPACE_KEY`), which this PR wires into the Process-PSModule workflow through `TestData`. Each public function also carries a `#SkipTest:FunctionTest` marker so the framework's source-code test suite passes while per-function tests are deferred. ## Technical details - Merged `main`: kept the implemented-module README over the placeholder (#15), adopted the Pester 6.x requirement (#16), and picked up the Process-PSModule workflow bump to v5.5.7 (#14). - Validated locally: 0 syntax parse errors, 0 PSScriptAnalyzer findings (repo linter and framework build rules), every public command's first `.LINK` resolves to its docs page, and the module assembles and imports with all 41 public functions. - Change type is **minor** (new functionality on a pre-1.0.0 module). Repository topics set to supply the manifest tags; `major`/`minor`/`patch`/`NoRelease` labels created for the release automation. - No linked issue — this work was driven directly; a tracking issue can be added for traceability. Opened as a **draft** for review.
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.
README pages now act as concise landing pages. Implemented modules point users to installation, psmodule.io, and PowerShell help instead of duplicating command reference content. Placeholder and in-progress modules now state their status clearly so users are not shown scaffold examples as working usage.
Changed: README pages defer to generated documentation
Implemented module READMEs now provide a short overview, installation commands, and links to generated documentation. Command usage remains in PowerShell help and generated docs.
Changed: Placeholder modules identify their status
Repositories that still contain scaffold or stub module code now say they are placeholders or in progress instead of showing template commands as if they worked.
Technical Details
README.mdonly.PSModule/Template-PSModule.