11.latest
Search…
⌃K
Links

Contribute to Documentation

The Umbraco Documentation is presented here on GitBook, however it is also a GitHub repository and is as open source as the Umbraco CMS.
You can contribute to the documentation if something is missing or outdated. All you need to do it is a GitHub account and a fork of the UmbracoDocs GitHub repository.
In this section you can learn about the different ways to contribute. You can also find guidelines for writing good documentation.

How to get started

There are many ways in which you can contribute to the Umbraco Documentation. The approach you choose to take, depends on what you want to achieve with your contribution.
We have a few guidelines to follow when writing documentation and we have some tools you can use for it.
The Umbraco Documentation is written using the MarkDown markup language. We have put together an article where you can learn more about MarkDown.
Learn how we structure and name files in the Umbraco documentation.

Multi version documentation

Whenever a new version of an Umbraco product is released, the previous way of doing things may change. This means that there needs to be mutliple version of our documentation.
We do this by having a Git branch for each of the major versions of Umbraco CMS.
We are currently testing how best to handle the versions in terms of all products including Cloud, Heartcore, Forms and Deploy.
For now all documentation will follow the Umbraco CMS major versions. We will add warnings and notes whenever the versions to not match.
Learn more about how we handle the multiple version of our documentation in the documenting multiple versions and products article.

Labels

On both Issues and Pull Requests we use labels to categorize the 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.

Contribution badge

If your Pull Request to any Umbraco repository gets merged, you will receive a Contributor badge on your profile on Our Umbraco:
Contributor badge on Our