Azure Technical Documentation Contributor Guide
You've found the GitHub repository that houses the source for the technical documentation that is published to the Azure Documentation Center at http://azure.microsoft.com/documentation.
This repository also contains guidance to help you contribute to our technical documentation. For a list of the articles in the contributors' guide, see the index.
Contribute to Azure documentation
Thank you for your interest in Azure documentation!
- Ways to contribute
- Code of conduct
- About your contributions to Azure content
- Repository organization
- Use GitHub, Git, and this repository
- How to use markdown to format your topic
- Feedback, comments, and support
- More resources
- Index of all contributors' guide articles (opens new page)
Ways to contribute
You can contribute to Azure documentation in a few different ways:
- Contribute to a forum discussion.
- Submit Disqus comments at the bottom of articles.
- You can easily contribute to technical articles in the GitHub user interface. Either find the article in this repository, or visit the article on http://azure.microsoft.com/documentation and click the link in the article that goes to the GitHub source for the article.
- If you are making substantial changes to an existing article, adding or changing images, or contributing a new article, you need to fork this repository, install Git Bash, Markdown Pad, and learn some git commands.
##Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
##About your contributions to Azure content
###Minor corrections
Minor corrections or clarifications you submit for documentation and code examples in this repo are covered by the Azure Website Terms of Use (ToU).
###Larger submissions
If you submit a pull request with new or significant changes to documentation and code examples, we'll send a comment in GitHub asking you to submit an online Contribution License Agreement (CLA) if you are in one of these groups:
- Members of the Microsoft Open Technologies group.
- Contributors who don't work for Microsoft.
We need you to complete the online form before we can accept your pull request.
Full details are available at http://azure.github.io/guidelines/#cla.
Repository organization
The content in the azure-content repository follows the organization of documentation on Azure.Microsoft.com. This repository contains two root folders:
\articles
The \articles folder contains the documentation articles formatted as markdown files with an .md extension.
Articles in the root directory are published to Azure.Microsoft.com in the path http://azure.microsoft.com/documentation/articles/{article-name-without-md}/.
- Article filenames: See our file naming guidance.
Articles within their own service folder are published to Azure.Microsoft.com in the path http://azure.microsoft.com/documentation/articles/service-folder/{article-name-without-md}/
- Media subfolders: The \articles folder contains the \media folder for root directory article media files, inside which are subfolders with the images for each article. The service folders contain a separate media folder for the articles within each service folder. The article image folders are named identically to the article file, minus the .md file extension.
\includes
You can create reusable content sections to be included in one or more articles. See Custom extensions used in our technical content.
\markdown templates
This folder contains our standard markdown template with the basic markdown formatting you need for an article.
\contributor-guide
This folder contains articles that are part of our contributors' guide.
Use GitHub, Git, and this repository
For information about how to contribute, how to use the GitHub UI to contribute small changes, and how to fork and clone the repository for more significant contributions, see Install and set up tools for authoring in GitHub.
If you install GitBash and choose to work locally, the steps for creating a new local working branch, making changes, and submitting the changes back to the main branch are listed in Git commands for creating a new article or updating an existing article
Branches
We recommend that you create local working branches that target a specific scope of change. Each branch should be limited to a single concept/article both to streamline work flow and reduce the possibility of merge conflicts. The following efforts are of the appropriate scope for a new branch:
- A new article (and associated images)
- Spelling and grammar edits on an article.
- Applying a single formatting change across a large set of articles (e.g. new copyright footer).
How to use markdown to format your topic
All the articles in this repository use GitHub flavored markdown. Here's a list of resources.
-
For our list of markdown editors, see the tools and setup topic.
Article metadata
Article metadata enables certain functionalities on the azure.microsoft.com web site, such as author attribution, contributor attribution, breadcrumbs, article descriptions, and SEO optimizations as well as reporting Microsoft uses to evaluate the performance of the content. So, the metadata is important! Here's the guidance for making sure your metadata is done right.
More resources
See the index of our contributor's guide for all our guidance topics.
