Skip to content

docs: direct product documentation to azure-docs-pr in CONTRIBUTING #19989

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.

Sign up for GitHub

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
torreymicrosoft wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

docs: direct product documentation to azure-docs-pr in CONTRIBUTING #19989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ If you'd like to start contributing to Bicep, you can search for issues tagged a
* If a significant amount of design is required, please include a proposal in the issue and wait for approval before working on code. If there's anything you're not sure about, please feel free to discuss this in the issue. We'd much rather all be on the same page at the start, so that there's less chance that drastic changes will be needed when your pull request is reviewed.
* We report on code coverage; please ensure any new code you add is sufficiently covered by tests.

### Documentation

User-facing Bicep product documentation (the content published to Microsoft Learn) lives in the [azure-docs-pr](https://github.com/MicrosoftDocs/azure-docs-pr) repository under `articles/azure-resource-manager/bicep/`, not in this repository. If your change needs documentation:

* Do not open a documentation-only PR here. Open it directly in azure-docs-pr so it lands in the repo that publishes to Learn and is routed to the docs owners for review.

@anthony-c-martin anthony-c-martin Jul 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The exception to this - which I'd mention here - is experimental features. We've been documenting them in this repo here, which the official docs links to.

* For a code change that needs docs, keep the code PR here and apply the `📘 Docs Needed` label. The documentation is authored separately in azure-docs-pr and tracked back to your PR. Once the docs merge, the label moves to `📘 Docs Completed`.

@anthony-c-martin anthony-c-martin Jul 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd mention that it's a good idea to put enough information about the feature in the PR description (e.g a couple of sentences, possibly a usage example) - such that a docs writer is able to pick it up and have a basic understanding of what it does.

* In-repo engineering docs (design notes, proposals, and contributor guides under `./docs`) still belong in this repository.

### Example Files

We are integrating the Bicep examples into the [Azure QuickStart Templates](https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/README.md). If you'd like to contribute new example `.bicep` files that showcase abilities of the language, please follow [these instructions](https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/README.md) to add them directly there. We can still take bug reports and fixes for the existing examples for the time being.
Expand Down
Loading