Skip to content

Commit 8af6dce

Browse files
committed
cleaning up github files
1 parent 1ce6416 commit 8af6dce

10 files changed

+49
-34
lines changed

CODEOWNERS .github/CODEOWNERS

File renamed without changes.

.github/CODE_OF_CONDUCT.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
2+
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.

.github/CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to Microsoft Azure Documentation
2+
3+
Thank you for taking the time to contribute to the Microsoft Azure documentation.
4+
5+
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.
6+
7+
## Code of Conduct
8+
9+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
10+
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.
11+
12+
## How can I contribute?
13+
14+
There are a variety of ways to contribute to the documentation, review the sections below to find out which one is right for you.
15+
16+
### Reporting Bugs and Suggesting Enhancements
17+
18+
Please use the Feedback tool at the bottom of any article to submit bugs and suggestions.
19+
20+
![Feedback Tool](media/feedback-tool.png)
21+
22+
## Editing in GitHub
23+
24+
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.
25+
26+
### Pull Request
27+
28+
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.

LICENSE .github/LICENSE

File renamed without changes.

LICENSE-CODE .github/LICENSE-CODE

File renamed without changes.
File renamed without changes.

.github/media/feedback-tool.png

15.4 KB
Loading

FETCH_HEAD

Whitespace-only changes.

README.md

+19-34
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,34 @@
1-
## Microsoft Open Source Code of Conduct
1+
# Microsoft Azure Documentation
22

3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4-
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.
5-
6-
## Contribute to Azure technical documentation
7-
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:
8-
9-
* **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.
3+
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.
104

11-
* **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.
5+
## Getting Started
126

13-
* **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.
7+
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.
148

15-
## About your contributions to Azure content
16-
### Minor corrections
17-
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).
9+
### Prerequisites
1810

19-
### Larger submissions from community members
20-
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.
11+
You've decided to provide a contribution, that's great! There are a few tools which are needed to contribute to the documentation.
2112

22-
## Tools and setup
23-
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).
13+
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.
2414

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

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

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

33-
### \includes
34-
You can create reusable content sections to be included in one or more articles.
23+
#### Install
3524

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

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

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

43-
## Labels
44-
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:
45-
46-
* **Change sent to author**: The author has been notified of the pending pull request.
47-
* **ready-to-merge**: Ready for review by our pull request review team.
48-
31+
## Code of Conduct
4932

33+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
34+
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 commit comments

Comments
 (0)