forked from joostdenijs/azure-content
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1088614
commit d26899f
Showing
2 changed files
with
47 additions
and
32 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,12 +1,45 @@ | ||
# README | ||
|
||
This folder contains all the information that an individual needs to start contributing articles to the azure-content repository. | ||
Learn the basics of contributing articles to the azure-content repository for WindowsAzure.com documentation. | ||
|
||
## Using GitHub, Git and this Repository | ||
##Before we can accept your pull request | ||
|
||
Thank you for your interest in Windows Azure documentation. Before we can accept your pull request, we need you to sign a Contribution License Agreement (CLA). Full details are available at [http://windowsazure.github.io/guidelines.html#cla](http://windowsazure.github.io/guidelines.html#cla). Please email a copy of the signed CLA to [[email protected]](mailto:[email protected]). | ||
|
||
##Repository organization | ||
|
||
The content in this repository follows the organization of documentation on WindowsAzure.com. This repository contains two root folders: | ||
|
||
### \articles | ||
|
||
The articles folder contains the documentation articles formatted as markdown files with a .md extension. Articles are published to WindowsAzure.com in the following path http://www.windowsazure.com/en-us/documentation/articles/{article-name-without-md}/. | ||
|
||
* **Article filenames:** Begin with the service name, such as *hdinsight*, and include the development language and a description of the subject matter. Dashes (-) separate the words. | ||
|
||
* **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. | ||
|
||
### \includes | ||
|
||
Content authors can create reusable content sections to be included into one or more articles. An include file is simple markdown (.md) file that can contain any valid markdown content including text, links, and images. All include markdown files must contained in the *\includes* directory in the root of this repository. | ||
|
||
* **Media subfolders:** The *\includes* folder contains a *\media* folder with folders for the images in each include. The includes image folders are named identically to the include file, minus the *.md* file extension. | ||
|
||
## Working with Windows Azure articles | ||
|
||
### Article template | ||
|
||
*Information to come.* | ||
|
||
**Referencing include files** - There is a specific syntax required for referencing include files.[WACOM.INCLUDE [include-short-name](../includes/include-file-name.md)] | ||
|
||
|
||
Note: An include file cannot reference to other includes. | ||
|
||
## Using GitHub, Git and this repository | ||
|
||
**Note:** Most of the information in this section will be a brief overview of the [GitHub Help] [] articles. If you are familiar with Git and GitHub, skip to the "Contribute/Edit Content" section for the particulars of the code/content flow of this repository. | ||
|
||
### Setting up your Fork of the Repository | ||
### Setting up your fork of the repository | ||
|
||
1. The first step to contributing to this project is setting up a GitHub account. If you have not done so already go to [GitHub Home] [] and do so now. | ||
2. Now that you have an account, you also need a copy of Git on your computer. Follow the instructions in the [Setting up Git Tutorial] [Set Up Git]. | ||
|
@@ -23,7 +56,7 @@ This folder contains all the information that an individual needs to start contr | |
|
||
Congratulations you have now set up your repository. The above steps will not need to be repeated again. | ||
|
||
### Contribute/Edit Content | ||
### Contribute and edit content | ||
|
||
In order for the contribution process to be as seamless as possible, the following procedure has been established. | ||
|
||
|
@@ -38,14 +71,14 @@ Each branch should be limited to a single concept/article both to streamline wor | |
* Spelling/Grammar Edits on an article. | ||
* Applying a single formatting change across a large set of articles (e.g. new copyright footer). | ||
|
||
#### Create a New Branch | ||
#### Create a new branch | ||
|
||
1. Open GitBash | ||
2. Type `git pull upstream master:<new branch name>` in the prompt. This will create a new branch locally copied from the latest WindowsAzure master branch. | ||
3. Type `git push origin <new branch name>` in the prompt. This will alert GitHub to the new branch. You should now be able to see the new branch in your fork of the repository on GitHub. | ||
4. Type `git checkout <new branch name>` to switch to your new branch. | ||
|
||
#### Add New Content or Edit Existing Content | ||
#### Add new content or edit existing content | ||
|
||
You can now navigate to the repository on your local machine using Windows Explorer. The repository files are in `C:\Users\<yourusername>\azure-content`. | ||
|
||
|
@@ -62,7 +95,7 @@ The `commit` command applies the staged changes to the repository. `-m` means yo | |
|
||
You can commit multiple times while you are doing your work, or you can wait and commit only once when you're done. | ||
|
||
#### Submit a Pull Request to the Main Repository | ||
#### Submit a pull request to the main repository | ||
|
||
When you are done with your work and are ready to have it merged into the central repository follow these steps. | ||
|
||
|
@@ -76,7 +109,7 @@ When you are done with your work and are ready to have it merged into the centra | |
|
||
One of the site administrators will now process your pull request. Your pull request will surface on the WindowsAzure/azure-content site under Issues. When the Pull Request is accepted, the issue will be resolved. | ||
|
||
#### Create a New Branch After Merge | ||
#### Create a new branch after merge | ||
|
||
After a branch has been successfully merged (i.e. your pull request has been accepted), do not continue working in the local branch that was successfully merged upstream. This can lead to merge conflicts if you submit another pull request. Instead, if you want to do another update, create a new local branch from the successfully merged upstream branch. | ||
|
||
|
@@ -92,7 +125,7 @@ You now have local copies (in a new local branch) of the work that you submitted | |
|
||
...and verifying the content. (The `checkout` command updates the files in `C:\Users\<yourusername>\Azure-Content` to the current state of the X2 branch.) Once you have checked out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it is best to delete it (see the following "Delete a Branch" section). | ||
|
||
#### Delete a Branch | ||
#### Delete a branch | ||
|
||
Once your changes have been successfully merged into the central repository you can delete the branch you used, as you will no longer need it. Any further work requires a new branch. To delete your branch follow these steps: | ||
|
||
|
@@ -102,32 +135,14 @@ Once your changes have been successfully merged into the central repository you | |
|
||
Congratulations, you have successfully contributed to the project. | ||
|
||
##Repository organization | ||
|
||
The content in this repository is organized in a specific way in order to support publishing the content into WindowsAzure.com. This repository must contain the following two root directories: | ||
|
||
•\articles - The articles directory contains the documentation articles represented as markdown files with a .md extension. Articles in this directory can be selected for publishing to WindowsAzure.com by a content manager. Articles that are published to WindowsAzure.com will be published in the following path http://www.windowsazure.com/en-us/documentation/articles/{article-name-without-md}/. | ||
◦ Article File names - Since the markdown file names will become segments of the WindowsAzure.com URLs, it is important that the filenames are selected carefully so they are descriptive and discoverable. | ||
|
||
◦ Media sub-directories - The \articles directory can contain one sub-directory named \media the media directory is designed to capture the images used within an article. The media directory should not contain any images in its root, but rather will contain a sub-directory for every article file with the same name as the article (if the article has images). If the article does not have images, than a corresponding media directory is not required. | ||
|
||
|
||
•\includes - The WindowsAzure.com site provides the ability for content authors to create reusable content sections or chunks that can be included into one or more documentation articles. An include file is simple markdown (.md) file that can contain any valid markdown content including text, links, and images. All include markdown files must contained in the \includes directory in the root of the repository. | ||
◦ Referencing Include Files - There is a specific syntax required for referencing include files.[WACOM.INCLUDE [include-short-name](../includes/include-file-name.md)] | ||
◦ Media sub-directories - Just as with articles, the \includes directory can contain one sub-directory named \media the media directory is designed to capture the images used within an include. The media directory should not contain any images in its root, but rather will contain a sub-directory for every include file with the same name as the include (if the include has images). If the include does not have images, than a corresponding media directory is not required. | ||
|
||
Note: An include file cannot reference to other includes. | ||
|
||
|
||
|
||
## Writing an Article using Markdown | ||
## Writing an article using Markdown | ||
|
||
All of the articles in this repository use Markdown. While a complete introduction (and listing of all the syntax) can be found here [Markdown Home] [], the relevent basics will be covered here. | ||
|
||
If you are looking for a good editor [Markdown Pad][] is a great editor for Windows. | ||
|
||
|
||
### Markdown Basics | ||
### Markdown basics | ||
|
||
Below is a list of the most common markdown syntax. | ||
|
||
|
@@ -156,7 +171,7 @@ Below is a list of the most common markdown syntax. | |
|
||
In order to make the transition into using markdown as easy as possible, each of the Article types has a template and sample in this folder. When starting a new article, create a new file in the appropriate folder in your local repository, and copy the template in. The template will already have the structure necessary for the table of contents to work correctly. Whereever there is a `(TODO: some description)`, replace with the desired text. If you are adding more sections than the table of contents has, make sure to both add a new line in the Table of Contents, and format the section header in the same fashion as the pre-existing ones. | ||
|
||
### Link and Image References | ||
### Link and image references | ||
|
||
Markdown has a really nice feature that allows a user to insert a reference instead of a url for images and links. The syntax for using this feature is: | ||
|
||
|
@@ -169,7 +184,7 @@ Markdown has a really nice feature that allows a user to insert a reference inst | |
|
||
At first glance this format seems inefficient. However, it allows us to have a convention where all links and image urls can be grouped together as opposed to spread throughout the article. Therefore, all (external) links and images will use references, with the reference definitions (the `[refID]: url` part) at the bottom of the file. This both makes maintaining external addresses easier, and can help streamline the process of copying images from github into windowsazure.com | ||
|
||
## Additional Information | ||
## Additional information | ||
|
||
* For more information on Markdown go to [their site][Markdown Home]. | ||
* For more information on using Git and GitHub first check out the [GitHub Help Section] [GitHub Help] and if necessary contact the site adminstrators. | ||
|
This file contains 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