Skip to content

Commit

Permalink
cleaning up github files
Browse files Browse the repository at this point in the history
  • Loading branch information
SyntaxC4 committed Sep 28, 2018
1 parent 1ce6416 commit 8af6dce
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 34 deletions.
File renamed without changes.
2 changes: 2 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
28 changes: 28 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to Microsoft Azure Documentation

Thank you for taking the time to contribute to the Microsoft Azure documentation.

This guide covers some general topics around contribution and refers out to our [contributors guide](https://docs.microsoft.com/contribute) for more detailed explanations where relevant.

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## How can I contribute?

There are a variety of ways to contribute to the documentation, review the sections below to find out which one is right for you.

### Reporting Bugs and Suggesting Enhancements

Please use the Feedback tool at the bottom of any article to submit bugs and suggestions.

![Feedback Tool](media/feedback-tool.png)

## Editing in GitHub

Follow the guidance for [Quick edits to existing documents](https://docs.microsoft.com/en-us/contribute/#quick-edits-to-existing-documents) in our contributors guide.

### Pull Request

Review the guidance for [Pull Requests](https://docs.microsoft.com/en-us/contribute/how-to-write-workflows-major#pull-request-processing) in our contributors guide.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file added .github/media/feedback-tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed FETCH_HEAD
Empty file.
53 changes: 19 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,34 @@
## Microsoft Open Source Code of Conduct
# Microsoft Azure Documentation

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Contribute to Azure technical documentation
We welcome contributions from our community as well as from Microsoft employees from outside the documentation teams. How you contribute depends on who you are and the sort of changes you'd like to contribute:

* **Community - minor updates**: If you are contributing minor updates out of the goodness of your heart, you can find the article in this repository, or visit the article on [https://docs.microsoft.com/azure](https://docs.microsoft.com/azure) and click the **Edit** link in the article that goes to the GitHub source for the article. Then, just use the GitHub UI to make your updates. Or, you are welcome to fork the repository and submit updates from your fork. See our general [contributor guide](https://docs.microsoft.com/contribute/) for more information.
Welcome to the open source [documentation](https://docs.microsoft.com/azure) of [Microsoft Azure](https://azure.microsoft.com). Please review this README file to understand how you can assist in contributing to the Microsoft Azure documentation.

* **Community - new articles + major changes**: If you're part of the Azure community and you want to create a new article or submit major changes, please submit an issue to start a conversation with the documentation team. Once you've agreed to a plan, you'll need to work with an employee to help bring that new content in through a combination of work in the public and private repositories.
## Getting Started

* **Employees**: If you are a technical writer, program manager, or developer from the product team for an Azure service and it's your job to contribute to or author technical articles, you should use the private repository (https://github.com/MicrosoftDocs/azure-docs-pr). Employees from other parts of the Microsoft world should use the public repo for minor updates.
Contributing to open source is more than just providing updates, it's also letting us know when there is an issue. Read our [Contributing guidance](.github/CONTRIBUTING.md) to find out more.

## 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 [docs.microsoft.com Terms of Use](https://docs.microsoft.com/legal/termsofuse).
### Prerequisites

### Larger submissions from community members
If you submit a pull request with significant changes to documentation and code examples, you'll see a message in the pull request asking you to submit an online contribution license agreement (CLA). We need you to complete the online form before we can review your pull request.
You've decided to provide a contribution, that's great! There are a few tools which are needed to contribute to the documentation.

## Tools and setup
Community contributors can use the GitHub UI or fork the repo to contribute - more information is available in our [contributor guide](https://docs.microsoft.com/contribute).
Contributing to the documentation requires a GitHub account, if you don't have an account, follow the instructions for [GitHub account setup](https://docs.microsoft.com/contribute/get-started-setup-github) from our contributor guide.

## Repository organization
The content in the azure-docs repository follows the organization of documentation on https://docs.microsoft.com/azure. This repository contains two root folders:
#### Download

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

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.
* [Git](https://git-scm.com/download)
* [Visual Studio Code](https://code.visualstudio.com/Download)
* [Docs Authoring Pack](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-authoring-pack)

### \includes
You can create reusable content sections to be included in one or more articles.
#### Install

## How to use markdown to format your topic
All the articles in this repository use GitHub flavored markdown. If you are not familiar with markdown, see:
Follow the instructions provided in the [Install content authoring tools](https://docs.microsoft.com/contribute/get-started-setup-tools) from our contributor guide.

* [Markdown basics](https://help.github.com/articles/markdown-basics/)
* [Printable markdown cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf)
## License

Please refer to [LICENSE](.github/LICENSE), [LICENSE-CODE](.github/LICENSE-CODE) and [ThirdPartyNotices](.github/ThirdPartyNotices) for all Licensing information.

## Labels
In the public azure-docs repository, automated labels are assigned to pull requests to help us manage the pull request workflow and to help let you know what's going on with your pull request:

* **Change sent to author**: The author has been notified of the pending pull request.
* **ready-to-merge**: Ready for review by our pull request review team.

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 comments on commit 8af6dce

Please sign in to comment.