Обновить

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Уровень сложностиПростой
Время на прочтение2 мин
Охват и читатели11K
Всего голосов 13: ↑9 и ↓4+6
Комментарии14

Комментарии 14

1) Что мешало использовать не онлайн-сервис GitBook, а его же, но запустив локально? Это же просто генератор статичного сайта (https://github.com/GitbookIO/gitbook). Gramax: 30 коммитов, 20 форков. GitBook: 2000 коммитов, 4k форков. Это не говорит плохо о Gramax, просто факт. Но Gramax отечественный, да.

2) Лозунг вашего сервиса "Это не просто дневник. Это пожизненный ИИ-ассистент" наводит на самые худшие мысли.

Интересно было бы знать, с чем именно не согласился минуснувший.

У Gramax симпатичный CPO. У GitBook такого нет.

CPO Gramax
CPO Gramax

В локальном GitBook не будет визуального редактора, комментариев и множества других функций, которые есть как в облачном GitBook, так и в Gramax.

В репозитории 30 коммитов, т.к. мы пока не переехали из локального GitLab в GitHub. Каждый месяц публикуем новый релиз в GitHub одним коммитом.

А зачем вы так делаете? Похоже на неправильное использование гита или я чего-то не понял. Ведь, можно просто одно репо мержить в другое и получать идентичные ветки

Сначала было ограничение, что Enterprise версия была в одном репозитории с Open Source версией. От этого ушли. Потом было ещё какое-то ограничение, точно не помню какое. Да и просто много других задач, до этой не добираемся.

Но думаю, что в скором времени полностью переедем, чтобы закрыть вопрос. Вся разработка будет в GitHub с пулл реквестами, комментариями и настоящим docs as code.

Здравствуйте. По 1 пункту расскажите пожалуйста, подробнее что вы имеете ввиду? Как осуществить публикацию документации созданной через гитбук на свой статичный сайт?

Здравствуйте, не совсем поняла ваш вопрос. Думаю вам поможет это:
- Опубликовать в облако Gramax: https://gram.ax/resources/docs/doc-portal/cloud-gramax
- Развернуть как статический сайт: https://gram.ax/resources/docs/doc-portal/static-site-generator

По первому пункту — команда Gramax уже ответила: локальный GitBook CLI лишён визуального редактора, комментариев и целого ряда функций, которые есть в Gramax. По коммитам — там же объяснено: разработка велась в локальном GitLab, на GitHub выкладывается по одному коммиту на релиз. Это не показатель зрелости кода.

По второму пункту — понимаю, что формулировка может звучать настораживающе. Поработаем над этим)

Используем BookStack..

Круто! Не знала о нём — почему ваш выбор пал именно на него?

Интересно знать его принципиальные отличия от давно существующего и так же бесплатного DokuWiki, на котором мы так же юзаем markdown.

А так же интересуют возможности движка в плане разграничения прав и доступа к различным частям документации.

Спасибо за вопрос! Ключевые отличия от DokuWiki:

  • Git-нативность — все изменения идут через pull request'ы, ревью, полная история версий "из коробки" без плагинов

  • Визуальный WYSIWYG-редактор — при этом всё хранится в чистом Markdown. DokuWiki использует собственный синтаксис, markdown там через плагин и не всегда ведёт себя предсказуемо

  • AI-поиск — можно подключить любую модель

В нашем проекте разграничение прав устроено следующим образом:

Так как у нас код проекта расположен на нашем сервере (мы используем GitLab Self-Hosted), чтобы его не нагружать нашей документацией и использовать бесплатную доску задач, я создала организацию на GitHub, там создала репозитории только для документации. В репозиториях дала доступ отдельным лицам — и всё)

Так выглядит это всё в Gramax:

При работе разработчики просто клонируют репозиторий с кодом и документацией (к которой имеют доступ) в одну папку:


мы используем для своей внутренней базы знаний. Перешли с confluence.
прекрасный продукт

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации