All contributions are welcome, and we encourage everyone to contribute to the documentation site.
All of the site is written in markdown, and you are expected to follow the formatting standards, which we have put in place already throughout the site. This is to make sure all of the content is readable and consistent.
Writing knowledgebase articles can help the HRZN community, allowing them to easily find answers to common questions and problems.
There are strict guidlines for the articles configuration, to make sure the site is consistent, and easy to use.
An example of an article configuration is below, it needs to be placed at the start of every article:
---
title: Introduction
description: What is this?
---title is the title, which the user sees on the page. This should be a short, but descriptive title, correctly capitalised. It should also begin with a relevant
emoji, to make it easier for the user to identify the article, if it is not part of a category.
description is a short description of the article, which the user sees on the page. This should be a short, but descriptive description, correctly capitalised.
Articles should be written about setting up, configuring, and using our services. For example, "Setting up Prometheus store", these topics can be interchangeably used for most hosts, however the article should be written according to using our services. This is to make sure the article is easy the user. You may also include screenshots (Which must be uploaded to the imgur service, and not a custom ShareX host) in the article, if you wish, these should be taken using our software (like our panel). If you don't have access to the software, you could let us know in the PR and we could take a screenshot for you, or give you a month's service, so you could do this yourself.