UmbracoCMSDocs [WIP]

This is the new repository for articles and tutorials on Umbraco on .NET Core.

This is NOT the official documentation for Umbraco CMS. The official UmbracoDocs can be found on github/UmbracoDocs or on our.umbraco.com.

Table of contents

• Reading and using the articles in this repo
• Try out Umbraco .NET Core (Umbraco 9)
• Contributing to the repository
• Status on Umbraco on .NET Core

Reading and using the articles

It is important to note that this entire repository is a work in progress (WIP), which means that it will not contain a completed section of the documentation for Umbraco.

All articles are divided into topics and each article can contain various subtopics. All topics and subtopics can be found under Articles.

Each tutorial in the Tutorials folder has its own folder, in which multiple files and subfolders might also be found.

Tags

To keep track of the state of the articles added to this repository, we will be working with and adding a series of tags to each article.

Here's an overview of the tags that we will be using.

v8-equivalent

A link to the Umbraco 8 version of the article. Should link directly to the file on Github as opposed to linking to Our. Not used on new articles written for the new version.

v8-equivalent: "https://github.com/umbraco/UmbracoDocs/blob/main/README.md"

state

Is that article complete? Is it only partially done, or is it simply an outline as a starting point?

state: partial | complete | outline

verified-against

Define which Umbraco 9 release the article has been verified against.

verified-against: alpha-3 | beta-1

versionFrom

Will determine the Umbraco version from which the article i valid.

versionFrom: 9.0.0

updated-link

As we start to migrate the documentation to Umbraco 9, it will not be possible to convert all links in the articles on the first go. This tag should be used to indicate whether the links in the article has been updated or not.

updated-links: true | false

Try out Umbraco on .NET Core

Umbraco on .NET Core is currently in alpha and everyone with an interest in Umbraco and the .NET Core framework is recommended to take it for a spin.

You can find instructions on how to get started with the product in the Umbraco on .NET Core - Updates article.

Contributing to the repository

We encourage any kind of contribution to this repository.

All files are written using Markdown. If you are new to Markdown make sure you learn the general as well as the UmbracoDocs specific Markdown conventions before getting started.

Write an article

Do you have some knowledge about Umbraco on .NET Core that you would like to share and that hasn't already been added to this repository?

Here are the steps you need to follow in order to add your article(s):

• Create a fork of this repository (UmbracoCMSDocs).
• Clone down your fork to your local machine.
• Create a new folder under Articles/ using the topic you will be covering in your article(s).
• Create an index.md file in the topic folder. This will be the landing page for the topic.
• Add an images/ folder to the topic, if you plan on using screenshots in the article.
• Use the name of the subtopic for the files (e.g. sub-topic.md) when adding more articles under the same topic.
• Write the article(s).
• Create a PR from your fork on this repository.

We strive to answer each PR within 48 hours during weekdays, not including holidays.

Write a tutorial

Have you written a guide on how to do something in Umbraco on .NET Core or do you know of a workflow to complete a certain task? And is this something you'd like to share with your fellow Umbracians?

Here are the steps you need to follow in order to add your tutorial(s):

• Create a fork of this repository (UmbracoCMSDocs).
• Clone down your fork to your local machine.
• Create a new folder under Tutorials/ using the name of the tutorial you will be creating.
• Create an index.md file in the topic folder. This will be the landing page for the tutorial.
• Add an images/ folder to the topic, if you plan on using screenshots in the tutorial.
• Use the step number for a new page, when creating a multi-page tutorial.
• Write the tutorial(s).
• Create a PR from your fork on this repository.

We strive to answer each PR within 48 hours during weekdays, not including holidays.

Link to your blog post

Did you write a blog post about Umbraco on .NET Core?

You are more than welcome to add the post to the list of community resources on the Umbraco on .NET Core - Updates article.

Follow these steps to add your blog post to the list:

• Select the Edit tool (pencil icon) in the top-right corner of the article.
• Add a link to your blog post below Community blog posts in the Community resources section of the article.
• Add a short description of the change you've made to the Commit changes dialog below the article.
• Choose Propose file change.
• Ensure your link and link title is correct and Submit the Pull Request (PR).

Report issues and ask questions

Did you find an issueswith one of the articles or tutorials in this repository?

Please let us know by creating an issue on the Issue Tracker and reference the article/tutorial in question.

You are also more than welcome to use the Issue Tracker for any questions or comments you might have about the repository and the articles in it.

If you have any questions about Umbraco on .NET Core and the progress of the project, please use contact@umbraco.com instead.

Status on Umbraco on .NET Core

To follow the current status of the Umbraco on .NET Core project keep an eye on the official Umbraco Blog.

You can also find fresh content about the project either directly from Umbraco HQ or from the community, on the Umbraco on .NET Core - Updates article.

The Official UmbracoDocs