Как начать заполнять раздел базы знаний?

Данная страница показывает как начать пользоваться данным разделом и как добавить новую страницу. База знаний представляет собой наборы отдельных страниц, собранные по группам. Все страницы находятся в папке content/how-to.

Общая информация

Cтраницы оформляются в формате Markdown (.md) и по умолчанию относятся к локали ru и будут показаны на русскоязычной версии сайта.

Для добавления страницы на другом языке необходимо указать локаль между названием файла и расширением. Например, страница 01-start.md относится к локали ru, страница 01-start.en.md - к локали en и будет показана на английской версии сайта.

В отличие от обычных Markdown файлов у данных страниц есть "шапка" (frontmatter), в ней задаются метаданные для страницы (название, описание). "Шапка" идет в самом начале файла markdown и обособляется с помощью последовательности символов ---.

Например, шапка для данной страницы выглядит так:

---
title: Как начать заполнять раздел базы знаний?
---

Все страницы должны быть собраны в группы. Группа - папка с файлами внутри content/how-to. Внутри группы должен находится файл с названием _index (_index.md или _index.en.md) - данное название файла зарезервировано и используется, чтобы задавать название и описание для группы. Например, так выглядит _index.md для данной группы страниц:

---
title: Быстрый старт
---
 
Советы по быстрому старту заполнения базы знаний

Названия файлов и папок - это части URL, поэтому должны содержать только последовательность букв, цифр и символа - (НИКАКОЙ КИРИЛЛИЦЫ ИЛИ ПОДЧЕРКИВАНИЙ). Название файла должно начинаться с %d-, где %d - это число. Числовая часть %d используется для выставления приоритета последовательности страниц в данной группе (Например, страница 01-start.md будет располагаться раньше, чем страница 02-continue.md).

Название группы/название файла без %d- формируют URL. Например, данная страница названа 01-start.md и находится в группе example, поэтому она доступна по адресу /ru/how-to/example/start.

Все добавленные группы файлов отображаются на странице /ru/how-to, сами страницы отображаются внутри групп. Например, провалившись в /ru/how-to/example можно найти эту страницу.

Если добавить в начало названия файла символ #, то данный файл считается черновиком и не попадает в финальную сборку портала.

Дополнительная информация о том как пользоваться Markdown файлами

Поля в "шапке" markdown файла

Поле title - обязательное, это заголовок страницы в нем следует указать рассматриваемый вопрос или тему.
Поле description - необязательное, указывается в случае, если необходимо добавить произвольное описание страницы, которое будет используется поисковыми индексами. По умолчанию в данное поле подставляется просто сырой текст всей страницы.