Create a New Version of an Article
Learn how to create and add new material to the Umbraco Documentation, including updated material for upcoming releases.
There are 2 common scenarios where you might want to add a new article to the Umbraco Documentation:
You are adding new material to the documentation site.
This includes topics or tutorials not previously covered..
You are updating an existing article for an Upcoming major version of a product.
Add New Material to the Documentation
When you are adding a brand new article to the Umbraco Documentation, there are a few questions that we recommend asking yourself before getting started:
The steps to create, write, and add a new article to the Umbraco Documentation are outlined below:
Access the UmbracoDocs GitHub repository.
Fork the repository.
Clone your fork to your local machine.
Create a new branch using the following naming convention:
productname/topic
Branch name example:
cms/new-content-app-tutorial
Locate the section or folder in the existing structure where your article fits.
Create a new
.md
file and name it using the title you will give the article.The file name needs to be in small caps and use hyphens instead of spaces.
File name example:
statistics-content-app-tutorial.md
.
Write the article following:
Add your new article to the file so it appears in the documentation navigation.
Commit and push your changes to your forked repository.
Update an Article for an Upcoming Major Version
The documentation is versioned using directories in the root of the repository. The major Umbraco CMS version number is used to name the directories, and you will find documentation for each versioned Umbraco product within them.
The following sections of the Umbraco Documentation follow the versioning strategy:
Umbraco CMS
Umbraco Forms
Umbraco Deploy
Umbraco Workflow
Umbraco Commerce
Umbraco UI Builder
Umbraco Engage
Once the RC is released, you can find the associated documentation using the version drop-down on the Documentation site.
Update an article for the upcoming release
Access the UmbracoDocs GitHub repository.
Fork the repository.
Clone your fork to your local machine.
Create a new branch using the following naming convention:
productnameXX/topic
Branch name example:
cms15/configuration
Locate the article you need to make changes to.
Make the necessary changes to the article.
Add and commit the changes.
Push the branch to your forked repository.
Last updated
Was this helpful?