Size: a a a

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

2021 November 08

AB

Albina Brycheva in DocOps-сообщество
структура папок такая
источник

NV

Nick Volynkin in DocOps-сообщество
Нет, исходники должны сразу лежать в нужном месте, зачем их копировать-то? )
источник

AB

Albina Brycheva in DocOps-сообщество
потому что после команды sphinx-quickstart в рабочей папке я вижу папку \source и исходников там нет. Они на уровень выше. Подозреваю, что я нарушаю последовательность действий

Upd: так и есть. Разобралась
источник

NV

Nick Volynkin in DocOps-сообщество
перепутал quickstart и autobuild
источник

NV

Nick Volynkin in DocOps-сообщество
quickstart запускается один раз в начале проекта и только создает шаблонные файлы и каркас проекта
источник

NV

Nick Volynkin in DocOps-сообщество
Порядок создания проекта такой:
1. в чистой папке делаете sphinx-quickstart, выбираете нужные настройки. Очень рекомендую разделить source и build, остальное по желанию.
2. Редактируете source/index.rst, добавляете новые файлы в source/
источник
2021 November 10

L

Lana in DocOps-сообщество
Вот эта статья родила под собой довольно большой тред обсуждений в слаке WTD про языки разметки для документации https://passo.uno/docs-as-code-tools-open-standards/ Там три основных пойнта: почему у нас до сих пор нет универсального и открытого языка разметки для доков и каким он должен быть, подходит ли гит для работы с документацией и еще про рендеринг документации браузерами.
источник

CL

Constantine Linnick in DocOps-сообщество
годная статья, а где дискуссия?
источник

ЕД

Егор Доронин... in DocOps-сообщество
Иногда кажется, что все технологии вокруг написания документации - это тлен и суета сует
источник

ЕД

Егор Доронин... in DocOps-сообщество
А лучшие доки те, которые пишут и сами используют
источник

ЕД

Егор Доронин... in DocOps-сообщество
И не так важно, как и в чем они написаны, как то, что они в целом есть
источник

CL

Constantine Linnick in DocOps-сообщество
я вот перепробовал пачку технологий и все будем честны остой полнейший сляпанный на коленке из того что было
источник

L

Lana in DocOps-сообщество
Мне еще понравилась картинка, которой проиллюстрировали мысль про yet another standard https://xkcd.com/927/
источник

J

Jonny Cuba in DocOps-сообщество
🤣👌
источник

L

Lana in DocOps-сообщество
Но на самом деле мысли там заложены интересные, вопрос в том, действительно ли обилие разметок наша основная проблема) Знаю кстати одного человека, который под себя лично разметку написал, потому что остальные под его задачи не подходили
источник

ЕД

Егор Доронин... in DocOps-сообщество
Недавно кто-то в сети писал неиронично: "стандарты это очень хорошо, стандартам надо следовать. Вот посмотрите на USB, как без стандарта было все беспорядочно"
Похоже, ему эта картинка за последние лет 10 ни разу не попадалась
источник

A

Angela in DocOps-сообщество
в слаке сообщества WTD
источник

A

Angela in DocOps-сообщество
канал # doc-as-code
источник

CL

Constantine Linnick in DocOps-сообщество
Telegram
Стой под стрелой
Все знают комикс XKCD про 14 competing standards. Типа, 14 конкурирующих стандартов это проблема, давайте придумаем один, который их объединит, ой, теперь у нас 15 конкурирующих стандартов.

Обычно его вспоминают, когда хотят кого-нибудь заткнуть: типа, че ты высовываешься, бери то, что есть и не придумывай.

И это все круто и понятно, кроме, собственно, одного момента: а как, по-вашему, эта ситуация должна разрешиться? Просто сидеть и ждать, когда тринадцать из четырнадцати отомрут? Да тут скорее я на пенсию выйду.

Штука в том, что если стандартов реально 14, значит, они все решают какую-то часть проблемы и не решают какую-то другую. То есть просто сидеть и ждать, когда один победит, явно не вариант, потому что победить ни один не может по определению.

А это значит, что все еще есть пространство перекомбинировать плюсы и выкинуть минусы, сделать 15-й, да, но не простым повторением, а с прицелом на то самое доминирование. Раз 14 стандартов до сих пор не могут выбрать победителя, может быть, нужно что-то качественно…
источник

CL

Constantine Linnick in DocOps-сообщество
отличная иллюстрация стандартов и простоте использования. Получать доступ в слак и искать я конечно не пойду
источник