Size: a a a

DocOps-сообщество

2021 June 15

FM

Fedor Moroseev in DocOps-сообщество
https://github.com/gollum/gollum кто-нибудь ставил себе?
источник

V

Vasiliy in DocOps-сообщество
Да, на Гитлабе wiki на Gollum работает
источник

FM

Fedor Moroseev in DocOps-сообщество
Интересно.
источник

RT

Roman Tsirulnikov in DocOps-сообщество
Спасибо

Я сейчас смотрю на вариант один проект в bitbucket, в котором созданы репозитории по продуктам. Документация сгруппирована по продуктам. Поиск в проекте BB найдет документы во всех репозиториях проекта.
источник

RT

Roman Tsirulnikov in DocOps-сообщество
соотв. вся дальнейшая декомпозиция на основе определения границ продуктов
источник

J

Jonny Cuba in DocOps-сообщество
я примерно также делаю, у нас только продукт один, но много модулей. Делаю папку docs (репозиторий для всех доков), в ней папка, например, project _name_1 , с нашим главным проектом, дальше проекты можно будет добавлять как 1,2,3 и т.д. это на случай расширения наших продуктов, и уже  в папке project _name_1, разбивка на модули, mod1, mod2 и т.д. По редми от разработчиков, решил его не подтягивать, будет бардак.
источник
2021 June 18

А

Александр Мокрушин... in DocOps-сообщество
Всем привет!
Вопрос для пользователей Sphinx.

Подскажите, пожалуйста, как включить контент файла index.rst в собираемый DOCX?

Если добавить index в директиву toctree, то появляется ошибка:

WARNING: circular toctree references detected, ignoring: index <- index
источник

NV

Nick Volynkin in DocOps-сообщество
Как вы думаете, что означает текст ошибки?
источник

А

Александр Мокрушин... in DocOps-сообщество
Ссылка ссылается на саму себя)

Интересно, что файл при этом формируется
источник

J

Jonny Cuba in DocOps-сообщество
Тоже вопрос по сфинкс, если несколько проектов с различной документацией, то как настраиваете  хранение файлов с документацией? По умолчанию файлы с докой лежат в корне. Как решение вижу папку source и в ней project1, project2 и т.д. но будет ли проходить сборка?
источник
2021 June 20

V

Vanger in DocOps-сообщество
Ну либо тегами при коммите отмечать, а потом при запуске пайплайна определять по нему что собирать
источник

V

Vanger in DocOps-сообщество
Но честно, я не понимаю зачем все в одном проекте держать
источник

NV

Nick Volynkin in DocOps-сообщество
Есть ли у проектов общие (переиспользуемые) части?
источник

J

Jonny Cuba in DocOps-сообщество
Пока не знаю, так как это больше к масштабируемости решения относится, но скорее всего будут.
источник

J

Jonny Cuba in DocOps-сообщество
а как можно сделать?
источник

V

Vanger in DocOps-сообщество
у нас каждая дока живёт в своей репе, где требуется реиспользование в другом проекте, подключается как субмодуль гита
источник

J

Jonny Cuba in DocOps-сообщество
интересно, спасибо
источник

А

Андрей in DocOps-сообщество
у нас также. самый оптимальный вариант
источник
2021 June 21

J

Jonny Cuba in DocOps-сообщество
Вы имеете ввиду, что документация лежит в репозитории с кодом модуля программы?
источник

А

Андрей in DocOps-сообщество
Документация лежит в своем отдельном репозитории. Код в своем. Умеем подтягивать дескрипшн из кода в доки внутри гита
источник