Skip to content

Commit

Permalink
additional changes requested by tysonn
Browse files Browse the repository at this point in the history
  • Loading branch information
Dene Hager committed Jun 25, 2015
1 parent 91e84a0 commit df6d9d6
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 14 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,18 @@ The content in the azure-content repository follows the organization of document

### \articles

The *\articles* folder contains the documentation articles formatted as markdown files with an *.md* extension. Articles are published to Azure.Microsoft.com in the path *http://azure.microsoft.com/documentation/articles/{article-name-without-md}/*.
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](./contributor-guide/file-names-and-locations.md).

* **Media subfolders:** The *\articles* folder contains the *\media* folder, inside which are subfolders with the images for each article. The article image folders are named identically to the article file, minus the *.md* file extension.
### \articles\service-folder

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

Expand Down Expand Up @@ -90,11 +97,8 @@ 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)



If you are looking for a good markdown editor, try [Atom Editor](https://atom.io/).


## 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).
Expand Down
16 changes: 10 additions & 6 deletions contributor-guide/create-links-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,21 @@ To link to an anchor in the same service subfolder:
[Configure your profile](service-folder/media-services-create-account.md#configure-your-profile)


Since includes are located in another directory, you will need to use relative paths as below. For a link to a single article, use this format:
## Custom markdown link syntax

[link text](../articles/file-name.md)
Since includes files are located in another directory, you will need to use relative paths as below. For a link to a single article from an includes file, use this format:

[link text](../articles/service-folder/article-name.md)

Learn more about how to use an includes file in the [Custom markdown extensions guidelines](custom-markdown-extensions.md#includes).

If you have selectors embedded in an include, you would use this sort of linking:

> [AZURE.SELECTOR-LIST (Dropdown1 | Dropdown2 )]
- [(Text1 | Example1 )](../articles/service-folder/example-azure-note.md)
- [(Text1 | Example2 )](../articles/service-folder/example-azure-selector-list.md)
- [(Text2 | Example3 )](../articles/service-folder/example-azure-selector-list2.md)
- [(Text2 | Example4 )](../articles/service-folder/example-code.md)
- [(Text1 | Example1 )](../articles/service-folder/article-name1.md)
- [(Text1 | Example2 )](../articles/service-folder/article-name2.md)
- [(Text2 | Example3 )](../articles/service-folder/article-name3.md)
- [(Text2 | Example4 )](../articles/service-folder/article-name4.md)

To link to a page on ACOM (such as a pricing page, SLA page or anything else that is not a documentation article), use an absolute URL, but omit the locale. The goal here is that links work in GitHub and on the rendered site:

Expand Down
22 changes: 19 additions & 3 deletions contributor-guide/custom-markdown-extensions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
<properties title="required" pageTitle="Custom markdown extensions used in our technical articles" description="Lists the custom markdown extensions that enable embedded videos, notes and tips, reusable content, and other item in azure.microsoft.com technical articles." metaKeywords="" services="" solutions="" documentationCenter="" authors="tysonn" videoId="" scriptId="" manager="required" />

<tags ms.service="contributor-guide" ms.devlang="" ms.topic="article" ms.tgt_pltfrm="" ms.workload="" ms.date="01/22/2015" ms.author="tysonn" />
<properties
title="required"
pageTitle="Custom markdown extensions used in our technical articles"
description="Lists the custom markdown extensions that enable embedded videos, notes and tips, reusable content, and other item in azure.microsoft.com technical articles."
services=""
solutions=""
documentationCenter=""
authors="tysonn"
manager="carolz"
editor=""/>/>

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

## Markdown for Azure.microsoft.com

Expand Down

0 comments on commit df6d9d6

Please sign in to comment.