Skip to content

propose new docs structure

Alexander Tolstoy requested to merge new-structure into main

Это вторая итерация после !159 (closed), изменения касаются только структуры сайта (расположение подразделов, их названия, имена файлов, структура файлов).

Изменения:

  • в "Ознакомление" добавил новый подраздел про обратную связь
  • "Глоссарий" переименован в "Основные концепции"
  • раздел "Работа с SQL в Picodata" удален из "Ознакомления". Материал частично переехал в broadcasted_sql.md в "Архитектуре".
  • вместо отдельного лендинга для подраздела SQL теперь есть просто broadcasted_sql.md в "Архитектуре".
  • auth_ldap.md теперь в "Инструкциях"
  • новый раздел "Подключение и работа в консоли" в "Инструкциях"
  • туториал по Lua и глобальным таблицам убрал. При необходимости, все команды с примерами можно посмотреть в api.md
  • удалены лишние/избыточные файлы
  • все картинки (*.svg) теперь в отдельной папке images
  • заголовки подразделов по возможности сделаны короче
  • внутренние ссылки между документами обновлены.

Предлагаю следующую структуру разделов сайта docs:

Ознакомление с ПО Picodata {: #getting-started }

Инструкции и руководства {: #manuals-and-howtos }

Справочные материалы {: #references }

Архитектура {: #arch }

Part of #79 (closed)

Merge request reports