Чат здесь: https://telegram.me/docsascode

Заготовки документации на разных инструментах с заранее настроенной сборкой и публикацией на GitLab Pages. Отличная песочница, чтобы попробовать разработку документации как кода. https://gitlab.com/pages/

Выпуск подкаста Write the Docs про документацию как код: https://www.youtube.com/watch?v=xT0WPZI62C4

Только что организаторы РИТ++ опубликовали видеозаписи докладов. Александр Тарасов из Одноклассников рассказывает о том, как вообще всё разрабатывать и хранить как код: от настроек рабочей машины до документации. https://www.youtube.com/watch?v=_Zm8ORdNT0Y&t=4s&list=PLH-XmS0lSi_w7TOjNYEpUV2wyVRN8YrIz&index=11

Интересное совпадение.

В исходниках документации Docker словарь с терминами — это также и словарь как структура данных «ключ» — «значение» в формате YAML.

Вот исходник: https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml

А так выглядит словарь в документации: https://docs.docker.com/glossary/

C новым годом, друзья!

Конспект про документацию как код: как это устроено, в чём преимущества. http://hackwrite.com/posts/docs-as-code/

Не совсем про код, но сделано очень хорошо. Было бы удобно иметь стайлгайды в такой форме.

Классификатор с сотней инструментов для редактирования и публикации документации. CMS, генераторы статических сайтов, редакторы XML, инструменты переводчика, вики-системы и всё остальное.

Выбор по операционной системе, платно-бесплатно, форматам входных данных и локализации, форматам для публикации, стандартам описания API.

https://doctoolhub.com

Сайт с конспектами документации разработчика: “TL;DR for developer documentation”.

https://devhints.io/

Изучаю Докер по урокам на сайте play-with-docker.com. Сайт очень классно сделан: слева — текст инструкций, справа — интерактивная консоль. Когда кликаешь на блоке кода в инструкции, он выполняется в консоли.

https://i.imgur.com/7MSteaw.png

Сайт сделан на Jekyll, исходники — в Markdown. Джекил собирает статические страницы и в каждую добавляет код JavaScript, который загружает динамическую консоль.

Консолей может быть несколько. Соответствие консоли и блока задается прямо в исходнике. После тройного бэктика — номер консоли: https://i.imgur.com/6g0xwUq.png

Самое классное, что сам этот сайт собирается в докере одной командой docker-compose up. Результат сразу виден по адресу http://localhost:4000/.

Не нужно ставить Jekyll и зависимости, разбираться в командах для сборки, вручную искать index.html. Всё просто работает.

Сам сайт: https://training.play-with-docker.com
Исходники: https://github.com/play-with-docker/play-with-docker.github.io