| description |
|---|
This page will give you all the information you need in order to start writing and contributing documentation articles to the UmbracoDocs. |
The Umbraco Documentation is presented here on Our Umbraco, but is in fact also a GitHub repository and it is as open source as the Umbraco CMS. Hej!
You can contribute to the documentation whenever you feel something is missing or out of date, and all you need to do it, is an account on GitHub.
In this section you can learn more about the various ways of contributing.
There are many ways in which you can contribute to the Umbraco Documentation. Which approach to take, depends on what you want to achieve with your contribution.
- Request a quick / minor change to an article by submitting a Pull Request
- Submit a more extensive update / change by forking the Documentation repository
- Raise a question, start a discussion or report an issue on the Issue Tracker
We have a few rules to follow when writing documentation, don't worry they are quite easy to follow and we have some tools you can use to help.
The Umbraco Documentation is written using the MarkDown markup language. We've put together an article where you can learn more about MarkDown here. You will also find an overview of the folder and file structure we use.
Whenever a new version of Umbraco is released new features might introduced and the "old way" of doing one thing, might have changed. This means that there will have to be several articles about the same thing, but with different information.
Therefor we've introduced versioned documentation, which includes 2 different mechanisms:
- The YAML meta data describing
versionFromandversionTo. - The possibility to add multiple files about the same topic
You can add meta data to any article in the Umbraco Documentation. This includes meta title and meta description as well as information on the versioning of the article.
On both Issues and Pull Requests we use labels to categories the various requests and submissions.
Here's a quick explanation of the labels groups (colors) we use:
- Category (e.g.
category/missing-documentation,category/umbraco-cloud,category/pending-release) - Community (e.g.
community/pr,help wanted) - State (e.g.
state/hq-discussion) - Status (e.g.
status/awaiting-feedback,status/idea) - Type (e.g.
type/bug)
Labels will be added to your Pull Request or Issue once it has been reviewed.
All the work of adding labels, going through issues and PRs and managing the Documentation repository is done by the Umbraco Documentation Curators team. If you wish to know more about who they are and how they work there is some information about them here: https://our.umbraco.com/get-involved/the-documentation-curators/
If you make a pull request to any Umbraco repository that gets merged, you will get a Contributor badge on your member profile on Our:
The Documentation Curators will search for your profile when merging a PR and add the badge. If it has been forgotten, make a comment on the closed/merged PR and we will do it as soon as possible!