Skip to content

Commit

Permalink
Merge pull request MicrosoftDocs#55 from Microsoft/contributor-guide-…
Browse files Browse the repository at this point in the history
…updates

Minor contributor guide updates to support lift and shift of content to docs
  • Loading branch information
tynevi authored Nov 3, 2016
2 parents 12c9974 + 9b1d53f commit 718a4a9
Show file tree
Hide file tree
Showing 18 changed files with 127 additions and 408 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md

This file was deleted.

38 changes: 11 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 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](http://azure.microsoft.com/documentation).
You've found the GitHub repository that houses the source for the Azure technical documentation that is published on [http://docs.microsoft.com/azure](http://docs.microsoft.com/azure).

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](https://github.com/Azure/azure-content/blob/master/contributor-guide/contributor-guide-index.md).
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](./contributor-guide/contributor-guide-index.md).

## Contribute to Azure documentation

Expand All @@ -20,11 +20,9 @@ Thank you for your interest in Azure documentation!

## Ways to contribute

You can contribute to [Azure documentation](http://azure.microsoft.com/documentation/) in a few different ways:
You can submit updates to the [Azure documentation](http://docs.microsoft.com/azure) as follows:

* Contribute to a [forum discussion](http://social.msdn.microsoft.com/Forums/windowsazure/home).
* 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](http://azure.microsoft.com/documentation) and click the link in the article that goes to the GitHub source for the article.
* 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://docs.microsoft.com/azur](http://docs.microsoft.com/azur) 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
Expand All @@ -35,36 +33,24 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope

###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)](http://azure.microsoft.com/support/legal/website-terms-of-use/).
Minor corrections or clarifications you submit for documentation and code examples in this repo are covered by the [docs.microsoft.com Terms of Use](https://docs.microsoft.com/en-us/enterprise-mobility-security/termsofuse).


###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](http://azure.github.io/guidelines/#cla).
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 not an employee of Microsoft. We need you to complete the online form before we can accept your pull request.

## Repository organization

The content in the azure-content repository follows the organization of documentation on [Azure.Microsoft.com](http://azure.microsoft.com). This repository contains two root folders:
The content in the azure-docs repository follows the organization of documentation on http://docs.microsoft.com/azure. This repository contains two root folders:

### \articles

The *\articles* folder contains the documentation articles formatted as markdown files with an *.md* extension.
The *\articles* folder contains the documentation articles formatted as markdown files with an *.md* extension. Articles are typically grouped by Azure service.

Articles in the root directory are published to Azure.Microsoft.com in the path *http://azure.microsoft.com/documentation/articles/{article-name-without-md}/*.
Articles need to follow strict file naming guidelines - for details, see [our file naming guidance](./contributor-guide/file-names-and-locations.md).

* **Article filenames:** See [our file naming guidance](./contributor-guide/file-names-and-locations.md).

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

Expand Down Expand Up @@ -100,11 +86,9 @@ All the articles in this repository use GitHub flavored markdown. Here's a list

- [Printable markdown cheatsheet](./contributor-guide/media/documents/markdown-cheatsheet.pdf?raw=true)

- For our list of markdown editors, see the [tools and setup topic](./contributor-guide/tools-and-setup.md#install-a-markdown-editor).

## 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](./contributor-guide/article-metadata.md).
Article metadata enables certain functionalities, 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](./contributor-guide/article-metadata.md).

### Labels

Expand Down
6 changes: 5 additions & 1 deletion contributor-guide/article-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

#Metadata for Azure technical articles

For metadata information, please see the [cross-product metadata guidelines for C+E product documentation](https://go.microsoft.com/fwlink/?linkid=833529) (Internal link only).


<!--
All Azure technical articles contain two metadata sections - a properties section and a tags section. The properties section enables some website automation and SEO stuff, while the tags section enables a lot of internal content reporting. Both sections are required.
- [Syntax]
Expand Down Expand Up @@ -308,7 +312,7 @@ In articles that specify both a services value and a documentationCenter value,
![](./media/article-metadata/checkmark-small.png) **ms.date**: Required. Specifies the date the article was last reviewed for relevance, accuracy, correct screen shots, and working links. Enter the date in mm/dd/yyyy format. This date also appears on the published article as the last updated date.
![](./media/article-metadata/checkmark-small.png) **ms.author**: Required. Specifies the author(s) associated with the topic. Internal reports (such as freshness) use this value to associate the right author(s) with the article. To specify multiple values you should separate them with semicolons. Either Microsoft aliases or complete email addresses are acceptable. The length can be no longer than 200 characters.
![](./media/article-metadata/checkmark-small.png) **ms.author**: Required. Specifies the author(s) associated with the topic. Internal reports (such as freshness) use this value to associate the right author(s) with the article. To specify multiple values you should separate them with semicolons. Either Microsoft aliases or complete email addresses are acceptable. The length can be no longer than 200 characters.-->


###Contributors' Guide Links
Expand Down
16 changes: 6 additions & 10 deletions contributor-guide/content-channel-guidance.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
<properties title="" pageTitle="Azure technical content channel guidance" description="Describes the Microsoft content channels that employees, partners, and community contributors should use for publishing Azure technical content." metaKeywords="" services="" solutions="" documentationCenter="" authors="tysonn" videoId="" scriptId="" manager="carolz" />

<tags ms.service="contributor-guide" ms.devlang="" ms.topic="article" ms.tgt_pltfrm="" ms.workload="" ms.date="01/06/2015" ms.author="tysonn" />

# Azure technical content channel guidance

GitHub is a relatively easy way (once you get over the Git hump) to author and publish technical content. But we need to ensure that content stays within the boundaries of technical documentation - there are other channels for other types of information.

##Technical content that belongs in the azure-content-pr repository
## Technical content that belongs in the azure-docs-pr repository

**Technical articles about using the product** belong in the azure-content and azure-content-pr repositories for publication to http://azure.microsoft.com/documentation/articles. They should contain conceptual or procedural information required to understand and use the product. The technical content channel is for technical content showing people **how** to do something. You can talk about the "what" and "why" to help customers understand intent, but the articles should focus on the actual content telling people how to do the task or complete the scenario.
**Technical articles about using the product** belong in the azure-docs and azure-docs-pr repositories for publication to http://docs.microsoft.com. They should contain conceptual or procedural information required to understand and use the product. The technical content channel is for technical content showing people **how** to do something. You can talk about the "what" and "why" to help customers understand intent, but the articles should focus on the actual content telling people how to do the task or complete the scenario.

##Technical content that does not belong in the azure-content-pr repository

**Reference content**: managed reference, REST APIs, PowerShell cmdlet help, schema reference, and error reference belongs in the MSDN scoped Azure library (http://msdn.microsoft.com/library/azure/). Node, Ruby, and other language reference content belongs on http://azure.github.io/.
## Technical content that does not belong in the azure-docs-pr repository

The following types of content are delivered in other Azure or Microsoft content channels; in some cases, certain types of content are not part of our content strategy.

Expand All @@ -22,7 +16,7 @@ The following types of content are delivered in other Azure or Microsoft content

- **Code and project samples**: Code and project samples go in the samples repositories and are featured in the sample gallery.

- **Community spotlight/community resources**: Articles featuring community projects. The repo is for technical content about how to use the product from the Microsoft persective, not about how people are using the product. That's marketing or possibly blog content. Or, let the community tell it's own story in the places that community likes best!
- **Community spotlight/community resources**: Articles featuring community projects. The repo is for technical content about how to use the product from the Microsoft perspective, not about how people are using the product. That's marketing or possibly blog content. Or, let the community tell it's own story in the places that community likes best!

- **Compliance**: Industry standards and compliance information for Azure services must be posted to https://www.microsoft.com/en-us/TrustCenter/Compliance?service=Azure#Icons. This includes certification for standards such as ISO, country-specific and government certifications, banking, health, or other certifications.

Expand All @@ -44,6 +38,8 @@ The following types of content are delivered in other Azure or Microsoft content

- **Redirect articles**: When you delete the content of an article, do not leave the article published with a link to the replacement content. Use a real redirect.

- **Reference content**: managed reference, REST APIs, PowerShell cmdlet help, schema reference, and error reference content is published to docs.microsoft.com, but not through this repository.

- **Release notes**: Unless it's an SDK article or a StorSimple article for a hardware update, this sort of information should just be embedded in the relevant technical content or included in the service updates channel.

- **What's new in a release or service**: Lists or descriptions of what is new in a release or service go to the Service Updates channel.
12 changes: 4 additions & 8 deletions contributor-guide/contributor-guide-index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
<properties title="" pageTitle="Azure technical content contributors' guide index" description="Lists the articles available in the Azure technical content contributors' guide for azure.microsoft.com." metaKeywords="" services="" solutions="" documentationCenter="" authors="tysonn" videoId="" scriptId="" manager="carolz" />
# Azure technical content contributors' guide index

<tags ms.service="contributor-guide" ms.devlang="" ms.topic="article" ms.tgt_pltfrm="" ms.workload="" ms.date="12/19/2014" ms.author="tysonn" />

#Azure technical content contributors' guide index

##General guidance
## General guidance

- [Contribute to Azure documentation](./../README.md)

Expand All @@ -15,7 +11,7 @@
- [Feedback, comments, and support](feedback-and-comments.md)


##Authoring articles: tools, processes, guidance
## Authoring articles: tools, processes, guidance

- [Tools and setup for authoring in GitHub](tools-and-setup.md)

Expand All @@ -38,7 +34,7 @@
- [Pull request comment automation](contributor-guide-pull-request-comments.md)


##Authoring articles: markdown
## Authoring articles: markdown

- [Markdown basics](https://help.github.com/articles/markdown-basics/)

Expand Down
5 changes: 3 additions & 2 deletions contributor-guide/contributor-guide-pr-criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ The updates in the pull request must comply with the following criteria to be me
|Site/design functionality| If H2 headings are present, the article contains at least two H2 headings. Using one H2 heading creates a single-item article TOC. H2 headings must be used before H3 headings to ensure a TOC is created.|
|Markdown| HTML: Source content does not contain HTML at the block level – minor inline HTML is permitted – such as superscript, subscript, special characters, and other minor things that you can’t do with markdown. HTML tables are allowed ONLY if the table contains bulleted or numbered lists, but that is usually an indication the content needs to be simplified so the source can be coded in markdown.|
|Markdown |Custom markdown elements are used where appropriate. Ex: Notes are coded using the AZURE.NOTE extension, not as plain text.|
|SEO |The " &#124; Microsoft Azure" site identifier is required|
|SEO |The " &#124; Microsoft Docs" site identifier is required|
|SEO |The *title* metadata value must include the word "Azure" |
|SEO |The H1 title contains sufficient information to describe the content of the article, to differentiate it from other Azure articles, and to map to likely customer keywords. For example "Overview" as the H1 title is a fail.|
|Terminology| The use of the ARM acronym, V1, or V2 as references to the classic and Resource Manager deployment models is a blocking terminology item.|
|Images |Animated GIFs are not accepted into the repo.|
|Images | Images have clear resolution, are free of misspelled words, and contain no private information |
|Images | Images have clear resolution, are free of misspelled words, and contain no private information |
|Staging|The article preview must be clean on staging. It cannot contain any obvious formatting issues: <br><br>- A numbered or bulleted list that appears as a paragraph <br> - Code in a code block appearing partly in the code block and partly outside it <br>- Numbered steps numbered incorrectly due to faulty indentation|

## Non-blocking content quality items
Expand Down
Loading

0 comments on commit 718a4a9

Please sign in to comment.