/Documentarian

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

Primary LanguagePowerShellCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Contributors Forks Stargazers Issues Code License: MIT Docs License: CC-BY


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 »

Report a problem · Ask a question · Propose an improvement

Table of Contents
  1. About the project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Legal Notices
  6. Acknowledgments

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

(back to top)

Getting Started

The Documentarian modules aren't yet available on the PowerShell Gallery. For now, you'll need to clone this repository and build them locally.

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

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

(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, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE 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)