Skip to content

Commit d22cda8

Browse files
authored
Update README.md
1 parent 55b8493 commit d22cda8

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1-
# azure-docs-powershell-azuread
2-
Cmdlets reference help docs for Powershell Azure AD
1+
# Microsoft AzureAD 2.0 PowerShell Module and AzureAD 2.0 Preview PowerShell Module Documentation
2+
3+
Welcome to the open-source [documentation](https://docs.microsoft.com/azure) of the [Microsoft AzureAD 2.0 PowerShell Module](https://docs.microsoft.com/powershell/module/azuread/?view=azureadps-2.0) and the [Microsoft AzureAD 2.0 Preview PowerShell Module](https://docs.microsoft.com/powershell/module/azuread/?view=azureadps-2.0-preview). Please review this README file to understand how you can assist in contributing to the Microsoft Azure documentation.
4+
5+
## Getting Started
6+
7+
Contributing to open source is more than just providing updates, it's also about letting us know when there is an issue. Read our [Contributing guidance](CONTRIBUTING.md) to find out more.
8+
9+
### Prerequisites
10+
11+
You've decided to contribute, that's great! To contribute to the documentation, you need a few tools.
12+
13+
Contributing to the documentation requires a GitHub account. If you don't have an account, follow the instructions for the [GitHub account setup](https://docs.microsoft.com/contribute/get-started-setup-github) from our contributor guide.
14+
15+
#### Download
16+
17+
Install the following tools:
18+
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) extension for Visual Studio Code
22+
23+
#### Install
24+
25+
Follow the instructions provided in the [Install content authoring tools](https://docs.microsoft.com/contribute/get-started-setup-tools) from our contributor guide.
26+
27+
## License
28+
29+
Please refer to [LICENSE](LICENSE), [LICENSE-CODE](LICENSE-CODE) and [ThirdPartyNotices](ThirdPartyNotices.md) for all Licensing information.
30+
31+
## Code of Conduct
32+
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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
35+
36+
## Current State of Repo
37+
We are currently aware of the backlog for this repo and are working to address this. Please be aware that if you have any updates to automatically generated reference content, you should create an issue and not a PR. The issue will then be created into a bug and filed against the feature team that owns the cmdlt. This is because tthe reference content must mirror the *dll-help.xml file and subsequent updates to the reference content may overwrite any changes made through the repo. Capturing it in the source code ensures that this does not occur. Any PR with changes to automatically generated reference content will be closed. This only applies to reference content and not conceputal content. Pull requests for changes to conceptual content are accepted and encouraged.

0 commit comments

Comments
 (0)