tarantool / tarantool/doc

[Epic] Docusaurus doc build implementation

Open
#3,535 0 comments 0 reactions 1 assignee View on GitHub

@lastoCHka42 is already working on this.

Since Jun 20, 2023.

epic
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Глобальная задача: внедрить пилотный проект движка разработки и публикации контента Docusaurus https://docusaurus.io

Наш репозиторий для работы: https://github.com/tarantool/doc-md

Желаемый результат

Документация по продукту в формате md (пилотным продуктом может быть, например, TCM) живет в репозитории tarantool/tcm-doc, собирается Docusarus'ом и деплоится на doc.tarantool.io.
На сайте tarantool.io в разделе документации есть пункт меню Documentation > TCM, при нажатии на этот пункт происходит редирект на doc.tarantool.io.

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

При открытии или обновлении ПР запускается деплой на тестовый сайт новой версии. ПР деплоится как версия документации, имя версии = имя ветки. При закрытии ПР этот деплой удаляется.

На doc.tarantool.io также работают нативные фичи Docusaurus:

  • поиск
  • механизм фидбэка через ПР
  • механизм локализации

ToDos

Основные шаги для настройки backend и верхнеуровневая оценка:

  • #3538

  • #3539

  • Настроить Docusaurus под все указанные требования - 5-8 дней
    Текущие требования:

    1. Сделать переключение версий
    2. Настройки для различных проектов со своими версиями
    3. Настройки локализации
    4. Редирект с tarantool.io/doc из пункта меню Documentation > TCM на doc.tarantool.io
  • #3540

  • #3541

P.S. Работы по фронтэнду сюда не включены, это работа на стороне teamU.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.