Заготовки документации на разных инструментах с заранее настроенной сборкой и публикацией на GitLab Pages. Отличная песочница, чтобы попробовать разработку документации как кода. https://gitlab.com/pages/
GitLab
GitLab Pages examples · GitLab
Example websites hosted by GitLab Pages. Learn how to contribute a new Pages site.
Выпуск подкаста Write the Docs про документацию как код: https://www.youtube.com/watch?v=xT0WPZI62C4
YouTube
WTD Episode 4: Continuous Integration and Docs as Code
We talk CI and how to get on board with Docs as Code. For more information, see http://podcast.writethedocs.org.
Только что организаторы РИТ++ опубликовали видеозаписи докладов. Александр Тарасов из Одноклассников рассказывает о том, как вообще всё разрабатывать и хранить как код: от настроек рабочей машины до документации. https://www.youtube.com/watch?v=_Zm8ORdNT0Y&t=4s&list=PLH-XmS0lSi_w7TOjNYEpUV2wyVRN8YrIz&index=11
YouTube
Everything as a Code / Александр Тарасов (Одноклассники)
Приглашаем на конференцию Saint HighLoad++ 2025, которая пройдет 23 и 24 июня в Санкт-Петербурге!
Программа, подробности и билеты по ссылке: https://highload.ru/spb/2025
________
РИТ++ 2017, Root Conf
Тезисы:
http://rootconf.ru/2017/abstracts/2627.html…
Программа, подробности и билеты по ссылке: https://highload.ru/spb/2025
________
РИТ++ 2017, Root Conf
Тезисы:
http://rootconf.ru/2017/abstracts/2627.html…
Интересное совпадение.
В исходниках документации Docker словарь с терминами — это также и словарь как структура данных «ключ» — «значение» в формате YAML.
Вот исходник: https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml
А так выглядит словарь в документации: https://docs.docker.com/glossary/
В исходниках документации Docker словарь с терминами — это также и словарь как структура данных «ключ» — «значение» в формате YAML.
Вот исходник: https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml
А так выглядит словарь в документации: https://docs.docker.com/glossary/
Конспект про документацию как код: как это устроено, в чём преимущества. http://hackwrite.com/posts/docs-as-code/
hack.write()
Docs as Code
Practices
Docs are written in plain text formats such as Markdown or reStructured Text.
Docs are stored as flat files, not database entries.
Docs are authored in a code editor of the writer's choice,
Docs are written in plain text formats such as Markdown or reStructured Text.
Docs are stored as flat files, not database entries.
Docs are authored in a code editor of the writer's choice,
Не совсем про код, но сделано очень хорошо. Было бы удобно иметь стайлгайды в такой форме.
Классификатор с сотней инструментов для редактирования и публикации документации. CMS, генераторы статических сайтов, редакторы XML, инструменты переводчика, вики-системы и всё остальное.
Выбор по операционной системе, платно-бесплатно, форматам входных данных и локализации, форматам для публикации, стандартам описания API.
https://doctoolhub.com
Выбор по операционной системе, платно-бесплатно, форматам входных данных и локализации, форматам для публикации, стандартам описания API.
https://doctoolhub.com