How to Contribute

Whether you've found a broken link or want to add a new article, this guide will help you contribute to the Umbraco documentation.

The Umbraco Documentation is presented here on GitBook. The documentation is also available as a GitHub repository and is open-source, just like the Umbraco CMS.

You can contribute to the documentation if something is missing or outdated. A GitHub account and a fork of the UmbracoDocs GitHub repository are required.

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.

• Request a quick/minor change to an article by submitting a Pull Request.

• Submit a more extensive update or change by forking the Documentation repository.

• Raise a question, start a discussion, or report an issue on the Issue Tracker.

• Help improve the readability of the documentation by verifying articles against our Style Guide.

Style guide

Consistency and readability are important when writing and reading documentation. When you contribute, follow the style guidelines and rules outlined in the Style Guide.

Markdown and formatting

The Umbraco Documentation is written using the Markdown markup language.

File names and structure

Learn how we structure and name files in the Umbraco documentation.

Writing documentation locally

Use a text editor like Visual Studio Code to make changes to the documentation locally. Although it is possible, it is not recommended to use an Integrated Development Environment (IDE) like Visual Studio for making changes to the documentation on your local machine. This is because the IDE may create files in the project that are not needed for the document changes to be implemented.

Multi-version documentation

Whenever a new version of an Umbraco product is released, the previous way of doing things may change. This means that multiple versions of our documentation must exist.

Versioning is done via the file structure, where all versioned products are located under a folder named by the major version of Umbraco.

For example, version folders such as '10' and '11' contain documentation specific to those product versions.

An overview of the file structure in the UmbracoDocs GitHub repository.

Umbraco Cloud and Umbraco Heartcore are not documented by version, which is why they are separate from this structure.

Learn more about how versioning is managed in the Documenting multiple versions and products article.

Labels

On both Issues and Pull Requests, labels are used to categorize the requests and submissions.

Here's a quick explanation of the labels (colors):

• Category

  • category/missing-documentation

  • category/umbraco-cloud

  • category/pending-release

• Community

  • community/pr

  • help wanted

• State

  • state/hq-discussion

• Status

  • status/awaiting-feedback

  • status/idea

• Type

  • type/bug

• Internal Review

  • review/docsteam

  • review/developer

Labels are added during the initial review of your pull request or issue.