Шаблон для подготовки туториалов для Базы Знаний на сайте Ред База Данных

Демонстрационно-учебные материалы по СУБД Ред База публикуются в разделе на сайте База знаний РЕД База Данных

[!Определение] Туториал — это:

Демонстрационно-учебный материал (далее: туториал) на основе конкретного практического примера, часто направленный на повторение описанных действий читателем для освоения материала на практике. Должен раскрывать способы применения и работы с СУБД Ред База Данных

При желании или необходимости, любой пользователь может подготовить и предложить для публикации на сайте свой туториал. Сотрудники компании одобрят предложенный материал для публикации после проверки на актуальность и соответствие принятым стандартам оформления.

Чтобы предложить свой туториал и правильно оформить его, пользователю необходимо выполнить несколько простых действий.

Для облегчения задачи пользователям предоставляется готовый шаблон-заготовка для создания новых туториалов, предназначенных для публикации в Базе знаний на сайте Ред База Данных.

Как получить шаблон?

Публичный репозиторий с набором готовых туториалов доступен пользователям на сайте Gitflic на странице red-soft/RdbTutorials. Эти публикации также можно использовать как примеры для подготовки и оформления. Содержание и структура каждого каталога одинаковы для большинства туториалов в этом репозитории.

В этом же репозитории находится каталог Tutorial_Template с готовым шаблоном-заготовкой для создания новых туториалов. Вы можете скачать этот каталог отдельно или клонировать весь репозиторий для дальнейшей работы.

Рекомендуется

• сделать fork этого репозитория и клонировать его себе на локальный компьютер,
• сделать в локальном репозитории копию каталога с шаблоном (Tutorial_Template) с новым именем для своей будущей публикации,
• отредактировать файлы SUMMARY.md и book.toml, которые необходимы для публикации, и заполнить их актуальными значениями согласно принятым правилам подготовки контента.
• подготовить свой туториал в виде файла в формате markdown.

Инструкции по пользованию шаблоном находятся в файле Readme.md в каталоге Tutorial_Template.

Когда туториал будет опубликован?

Сотрудник компании REDSoft, отвечающий за базу знаний СУБД Ред База Данных, рассмотрит ваш запрос на слияние на странице репозитория red-soft/RdbTutorialsна Gitflic и (если все хорошо) одобрит публикацию. Спустя некоторое время ваш туториал будет опубликован на сайте

Дата последнего изменения: 07.11.2026

Если вы нашли ошибку, пожалуйста, выделите текст и нажмите Ctrl+Enter.