How to start filling out the knowledge base section?

This page shows how to start using this section and how to add a new page. The knowledge base is a collection of individual pages grouped together. All pages are located in the content/how-to folder.

General information

Pages are formatted in Markdown (.md) and by default belong to the ru locale and will be displayed on the Russian-language version of the site.

To add a page in another language, you must specify the locale between the file name and the extension. For example, the page start.md belongs to the locale ru, the page start.en.md belongs to the locale en and will be displayed on the English version of the site.

Unlike regular Markdown files, these pages have a “header” (frontmatter) that specifies metadata for the page (title, description). The header goes at the very beginning of the Markdown file and is separated by a sequence of characters ---.

For example, the front matter for this page looks like this:

---
title: How to start filling out the knowledge base section?
---

All pages must be grouped together. A group is a folder with files inside content/how-to. Inside the group, there must be a file named _index.md (or _index.en.md) — this file name is reserved and is used to specify the name and description for the group. For example, this is what _index.md looks like for this group of pages:

---
title: Quick Start
---
 
Tips for a quick start fill

File and folder names are part of the URL, so they must only contain a sequence of letters, numbers, and the - symbol (NO CYRILLIC CHARACTERS OR UNDERLINES). The file name must begin with %d-, where %d is a number. The numerical part %d is used to set the priority of the sequence of pages in a given group (for example, the page 01-start.md will be located before the page 02-continue.md).

• Group name/file name form the URL. For example, this page is named start.md and is located in the example group, so it is accessible at /en/how-to/example/start.

All added file groups are displayed on the page /en/how-to, and the pages themselves are displayed within the groups. For example, if you go to /en/how-to/example, you can find this page.

If you add the # symbol to the beginning of a file name, that file is considered a draft and will not be included in the final portal build.

Additional information on how to use Markdown files

Fields in the “header” of a Markdown file

• The title field is mandatory; it is the page title and should contain the question or topic being discussed.
• The description field is optional and is used if you need to add a custom description of the page that will be used by search indexes. By default, this field is filled with the raw text of the entire page.