Size: a a a

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

2020 March 03

KC

Kseniya Chudakova in DocOps-сообщество
Borys Shchuko
Таких, чтоб агрегировали документы из разных реп в один сайт?
"коробочное" всегда приходится дорабатывать под свои нужды
источник

BS

Borys Shchuko in DocOps-сообщество
Kseniya Chudakova
"коробочное" всегда приходится дорабатывать под свои нужды
В том-то и вопрос: есть ли что-то коробочное под мой кейс? Хотя бы что-то близкое. Описание кейса повторю, извините:
"Репозиториев у нас сотни, ибо продукт большой.
Репозитории лежат на GitLab (self-hosted) и на Github.
Технические документы пишутся на
markdown и лежат в репах так же, как код. Документы по конкретному сервису лежат именно в его репе."

Выше мне предложили Аскидоктор + антора. Нормально, но это для asciidoc. А существует ли аналог для markdown?
источник

BG

Bogdan (SirEdvin) Gladyshev in DocOps-сообщество
Sphinx?
источник

L

Lana in DocOps-сообщество
Borys Shchuko
В том-то и вопрос: есть ли что-то коробочное под мой кейс? Хотя бы что-то близкое. Описание кейса повторю, извините:
"Репозиториев у нас сотни, ибо продукт большой.
Репозитории лежат на GitLab (self-hosted) и на Github.
Технические документы пишутся на
markdown и лежат в репах так же, как код. Документы по конкретному сервису лежат именно в его репе."

Выше мне предложили Аскидоктор + антора. Нормально, но это для asciidoc. А существует ли аналог для markdown?
вопрос тогда в том, что входит в слово нормально, какие элементы разметки и иные возможности нужны?
источник

NV

Nick Volynkin in DocOps-сообщество
ID:0
А кто знает хорошие примеры gRPC API? Чтобы и написано понятно было, и читать удобно. Пожалуйста, напишите мне (@Nick_Volynkin) или в чат @docsascode.
Никто не пишет. Видимо, хороших примеров нет. )
источник

FM

Fox Mulder in DocOps-сообщество
Я даже не знаю что это ))
источник

BS

Borys Shchuko in DocOps-сообщество
Lana
вопрос тогда в том, что входит в слово нормально, какие элементы разметки и иные возможности нужны?
Абзацы, заголовки, списки, цитаты, код, картинки, ссылки, таблицы, выделение текста, автоссылки. Всё это есть в документах.

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

L

Lana in DocOps-сообщество
Borys Shchuko
Абзацы, заголовки, списки, цитаты, код, картинки, ссылки, таблицы, выделение текста, автоссылки. Всё это есть в документах.

На централизованном сайте нужна древовидная раскрывающаяся структура и глобальный поиск.
Это в целом почти стандартный набор, может ref только не везде, берите почти любой ssg из ссылки выше (staticgen.com), просто отсортировать те, что исходником умеют md: Jekyll, gatsby, Hugo, mkdocs, foliant, docusaurus
источник

BS

Borys Shchuko in DocOps-сообщество
Lana
Это в целом почти стандартный набор, может ref только не везде, берите почти любой ssg из ссылки выше (staticgen.com), просто отсортировать те, что исходником умеют md: Jekyll, gatsby, Hugo, mkdocs, foliant, docusaurus
Насколько я вижу из описаний, mkdocs, docusaurus, hugo, gatsby не умеют публиковать контент сразу из нескольких репозиториев (а это нужно в моём случае). Есть ли среди всего этого моря тулов умеющий это делать? Т.е. как Antora, но для маркдауна.
источник

EN

Ekaterina Noskova in DocOps-сообщество
Borys Shchuko
Насколько я вижу из описаний, mkdocs, docusaurus, hugo, gatsby не умеют публиковать контент сразу из нескольких репозиториев (а это нужно в моём случае). Есть ли среди всего этого моря тулов умеющий это делать? Т.е. как Antora, но для маркдауна.
публикуйте отдельными приложениями с одинаковой версткой и сделайте им схожие URL через cname. docs.site.com/api, docs.site.com/guides, docs.site.com/db и т.п. docs.site.com будет разводящей со ссылками на остальные доки. поиск можно через Algolia например настроить, но нужно смотреть, как будет работать с разными приложениями.
источник

EN

Ekaterina Noskova in DocOps-сообщество
другой вариант. делаете отдельный репозиторий, куда настраиваете автоматическую синхронизацию документации из всех репозиториев. и публикуете как отдельное приложение
источник

ME

Maria Ermakovich in DocOps-сообщество
Ekaterina Noskova
другой вариант. делаете отдельный репозиторий, куда настраиваете автоматическую синхронизацию документации из всех репозиториев. и публикуете как отдельное приложение
вот это самое разумное кажется. но тогда должен быть и редирект на редактирование сорса
источник

iv

iakov v in DocOps-сообщество
Borys Shchuko
Насколько я вижу из описаний, mkdocs, docusaurus, hugo, gatsby не умеют публиковать контент сразу из нескольких репозиториев (а это нужно в моём случае). Есть ли среди всего этого моря тулов умеющий это делать? Т.е. как Antora, но для маркдауна.
сделайте себе отдельный master repository и подключите все остальные в него как submodules
источник

iv

iakov v in DocOps-сообщество
сами по себе ssg не особо умеют ходить в репозитории удаленные, они работают с тем, что есть в файловой системе
источник

L

Lana in DocOps-сообщество
Borys Shchuko
Насколько я вижу из описаний, mkdocs, docusaurus, hugo, gatsby не умеют публиковать контент сразу из нескольких репозиториев (а это нужно в моём случае). Есть ли среди всего этого моря тулов умеющий это делать? Т.е. как Antora, но для маркдауна.
Gatsby вроде умеет, там есть source-git, но я не тестировала
источник

KV

Konstantin Valeev in DocOps-сообщество
Borys Shchuko
Насколько я вижу из описаний, mkdocs, docusaurus, hugo, gatsby не умеют публиковать контент сразу из нескольких репозиториев (а это нужно в моём случае). Есть ли среди всего этого моря тулов умеющий это делать? Т.е. как Antora, но для маркдауна.
источник
2020 March 04

RG

Ramil G in DocOps-сообщество
Судя по описанию, очень крутая штуковина. Кто реально пользуется?
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Ramil G
Судя по описанию, очень крутая штуковина. Кто реально пользуется?
Мы пользуемся, прекрасная вещь

ТЗ пишем в markdown'е в git'е, один файл - одна фича.
Для совместимости с чужими процессами можно выгрузить docx и залить в Google Docs

Единственное, там нужно явно указывать все исходники в foliant.yml, а нам удобнее чтоб файловая структура отражала оглавление (тогда дерево папок и файлов в любом редакторе даёт работать с файлами как с обычным оглавлением в Word'е)

Но это решает скрипт с find, который по файлам собирает пути и кладёт в foliant.yml
источник

KV

Konstantin Valeev in DocOps-сообщество
Ramil G
Судя по описанию, очень крутая штуковина. Кто реально пользуется?
Мы пользуемся :)
источник

SR

Stas Rychkov in DocOps-сообщество
Привет. А нет ли у кого хорошего подробного описания работы с какими-то плейбуками Ansible?

Хочется посмотреть, кто как описывает работу со своими плейбуками. В качестве шаблона.

Чтоб для новичков. Кроме очевидных.

Спасибо.
источник