-
Notifications
You must be signed in to change notification settings - Fork 399
Added contribute to ref docs article #3559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mikefrobbins
wants to merge
1
commit into
MicrosoftDocs:main
Choose a base branch
from
mikefrobbins:mr-azps-427426
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: How to contribute to Azure PowerShell reference documentation | ||
description: Learn how Azure PowerShell reference documentation is generated, where to contribute, and how to update published versions. | ||
ms.topic: conceptual | ||
ms.service: azure-powershell | ||
ms.devlang: powershell | ||
ms.custom: devx-track-azurepowershell | ||
--- | ||
|
||
# How to contribute to Azure PowerShell reference documentation | ||
|
||
Understanding how Azure PowerShell reference documentation is generated and maintained ensures your | ||
updates are applied correctly and persist across versions. | ||
|
||
## What is reference documentation? | ||
|
||
Azure PowerShell reference documentation is versioned and autogenerated for each cmdlet in the | ||
**Az** PowerShell module. It includes: | ||
|
||
- Syntax and parameters | ||
- Usage examples | ||
- Output descriptions | ||
|
||
Docs are generated from the source code and are published once per module version. | ||
|
||
> [!IMPORTANT] | ||
> Changes to the source repo only apply to future versions. Previously published versions must be | ||
> updated manually. | ||
|
||
## How reference docs are generated | ||
|
||
Each Azure PowerShell submodule contains source code that defines the behavior and structure of its | ||
cmdlets. From this codebase: | ||
|
||
- A **Markdown help file** is generated per cmdlet, for example, | ||
`Update-AzVirtualHubVnetConnection.md` | ||
- These files live in the [azure-powershell GitHub repo](https://github.com/Azure/azure-powershell) | ||
- Markdown files are **overwritten** when a developer rebuilds or updates the module | ||
|
||
If you're contributing, update both: | ||
|
||
1. The Markdown file (for visibility in the repo) | ||
1. The cmdlet's source code (to ensure your change persists in future releases) | ||
|
||
## How reference docs are published | ||
|
||
When a new version of **Az** PowerShell module is released: | ||
|
||
- A CI process creates a pull request in the | ||
[azure-docs-powershell](https://github.com/MicrosoftDocs/azure-docs-powershell) GitHub repo | ||
- This PR adds generated Markdown files for that version, for example, `azps-13.4.0/Az.Network/` | ||
- This process runs **once per version**. The Markdown files are **not updated again** automatically | ||
|
||
## How to update existing versions | ||
|
||
To fix or improve docs for a previously published version: | ||
|
||
1. Navigate to the appropriate version folder in this repo, for example `azps-13.4.0/Az.Network/` | ||
1. Edit the Markdown file directly | ||
1. Submit a PR for review | ||
|
||
> [!NOTE] | ||
> Reference documentation is versioned and static at publish time. Manual edits are the only way to | ||
> update content for already-published versions. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider using sequential numbering (e.g., '1.', '2.') for the step list to enhance clarity, even though Markdown auto-numbers lists.
Copilot uses AI. Check for mistakes.