Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/Documentarian

An open source toolkit for documentarians and community contributors to reduce friction and provide a delightful experience for contributing to and maintaining documentation.
https://github.com/microsoft/Documentarian

Last synced: about 2 months ago
JSON representation

An open source toolkit for documentarians and community contributors to reduce friction and provide a delightful experience for contributing to and maintaining documentation.

Awesome Lists containing this project

README 

        









[![Contributors][14]][contributors-url]

[![Forks][15]][forks-url]

[![Stargazers][17]][stars-url]

[![GitHub Discussions][26]][discussions-url]

[![Issues][16]][issues-url]









[![Code License: MIT][12]][license-code-url]

[![Docs License: CC-BY][13]][license-docs-url]











  

  
Documentarian Modules



An open source toolkit for documentarians and community contributors to reduce friction and provide

a delightful experience for contributing to and maintaining documentation.



[**Explore the docs »**][h0]







[Report a problem][h1] · [Ask a question][h2] · [Propose an improvement][h3]






Table of Contents



1. [About the Project](#about-the-project)

   - [Built With](#built-with)

1. [Getting Started](#getting-started)

   - [Prerequisites](#prerequisites)

   - [Installation](#installation)

1. [Roadmap](#roadmap)

1. [Contributing](#contributing)

1. [Legal Notices](#legal-notices)



## About The Project



The Documentarian Modules are an open source toolkit for documentarians and community contributors

to reduce friction and provide a delightful experience for contributing to and maintaining

documentation.



(back to top)



### Built With



- [![PowerShell][11]][pwsh-url]



(back to top)



## Getting Started



The Documentarian modules aren't yet available on the [PowerShell Gallery][22]. For now, you'll

need to [manually download and install them][27].



### Prerequisites



This is an example of how to list things you need to use the software and how to install them.



- PowerShell 7.2 or later



### Installation



Not yet available. See [Contributing][01]



(back to top)



## Roadmap



See the [open issues][06] for a full list of [proposed features][08] (and [known issues][07]).



(back to top)



## Contributing



This project welcomes contributions and suggestions. Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.



When you submit a pull request, a CLA bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the

instructions provided by the bot. You will only need to do this once across all repos using our

CLA.



This project has adopted the [Microsoft Open Source Code of Conduct][19].



(back to top)



## Legal Notices



Microsoft and any contributors grant you a license to the Microsoft documentation and other content

in this repository under the [Creative Commons Attribution 4.0 International Public License][02],

see the [LICENSE][23] file, and grant you a license to any code in the repository under the

[MIT License][21], see the [LICENSE-CODE][24] file.



Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the

documentation may be either trademarks or registered trademarks of Microsoft in the United States

and/or other countries. The licenses for this project do not grant you rights to use any Microsoft

names, logos, or trademarks. Microsoft's general trademark guidelines can be found at

http://go.microsoft.com/fwlink/?LinkID=254653.



Privacy information can be found at https://privacy.microsoft.com/en-us/.



Microsoft and any contributors reserve all other rights, whether under their respective copyrights,

patents, or trademarks, whether by implication, estoppel or otherwise.



(back to top)



[contributors-url]: https://github.com/microsoft/Documentarian/graphs/contributors

[forks-url]: https://github.com/microsoft/Documentarian/network/members

[stars-url]: https://github.com/microsoft/Documentarian/stargazers

[issues-url]: https://github.com/microsoft/Documentarian/issues

[discussions-url]: https://github.com/microsoft/Documentarian/discussions

[license-code-url]: https://github.com/microsoft/Documentarian/blob/main/LICENSE-CODE

[license-docs-url]: https://github.com/microsoft/Documentarian/blob/main/LICENSE

[pwsh-url]: https://learn.microsoft.com/powershell



[h0]: https://microsoft.github.io/Documentarian

[h1]: https://github.com/microsoft/Documentarian/issues/new?assignees=&labels=bug%2Cneeds-triage&template=code-bug.yml

[h2]: https://github.com/microsoft/Documentarian/discussions/new?category=q-a

[h3]: https://github.com/microsoft/Documentarian/discussions/new?category=code-proposals



[01]: #contributing

[02]: https://creativecommons.org/licenses/by/4.0/legalcode

[06]: https://github.com/microsoft/Documentarian/issues

[07]: https://github.com/microsoft/Documentarian/labels/bug

[08]: https://github.com/microsoft/Documentarian/discussions/categories/code-proposals

[11]: https://img.shields.io/badge/PowerShell-v7.2-blue?logo=powershell

[12]: https://img.shields.io/badge/License%20(Code)-MIT-green?style=for-the-badge

[13]: https://img.shields.io/badge/License%20(Docs)-CC--BY--4.0-green?style=for-the-badge

[14]: https://img.shields.io/github/contributors/microsoft/Documentarian?style=for-the-badge

[15]: https://img.shields.io/github/forks/microsoft/Documentarian.svg?style=for-the-badge

[16]: https://img.shields.io/github/issues/microsoft/Documentarian.svg?style=for-the-badge

[17]: https://img.shields.io/github/stars/microsoft/Documentarian.svg?style=for-the-badge

[19]: CODE_OF_CONDUCT.md

[21]: https://opensource.org/licenses/MIT

[22]: https://powershellgallery.com

[23]: LICENSE

[24]: LICENSE-CODE

[26]: https://img.shields.io/github/discussions/microsoft/Documentarian?style=for-the-badge

[27]: https://microsoft.github.io/Documentarian/docs/authoring/install-tools/