Разработка документации — от постановки до деплоя (Екатерина Носкова, SECR-2018) — различия между версиями
Материал из 0x1.tv
StasFomin (обсуждение | вклад) (Новая страница: «;{{SpeakerInfo}}: {{Speaker|Екатерина Носкова}} <blockquote> В докладе я расскажу, как в компании Xsolla устрое…») |
StasFomin (обсуждение | вклад) |
||
Для решения задач документирования мы используем генератор статических сайтов Hugo (markdown + Go templates + YAML) и Gitlab CI/CD. Статические страницы документации собираются из шаблонов и публикуются в HTML на 6 языках. Каждый шаблон описывает логику сборки страницы в соответствии с типом контента. Для локализации документации используется подход Continuous localization, который реализован через связку Gitlab CI/CD + Serge + Smartcat. Доклад будет интересен техническим писателям, разработчикам и менеджерам проектов, которым необходимо решать схожие задачи документирования. </blockquote> {{VideoSection}} {{vimeoembed|287827976|800|450}} {{youtubelink|}}{{letscomment}} {{SlidesSection}} [[File:Разработка документации — от постановки до деплоя (Екатерина Носкова, SECR-2018).pdf|left|page=-|300px]] {{----}} [[File:{{#setmainimage:Разработка документации — от постановки до деплоя (Екатерина Носкова, SECR-2018)!.jpg}}|center|640px]] {{LinksSection}} * [https://2018.secrus.org/program/submitted-presentations/developing-documentation/ Talks page on SECR site] <!-- <blockquote>[©]</blockquote> --> <references/> |
Версия 09:30, 1 ноября 2018
- Докладчик
- Екатерина Носкова
В докладе я расскажу, как в компании Xsolla устроен процесс создания и публикации документации для разработчиков, которые хотят интегрировать решения Xsolla. Какие инструменты и подходы мы используем, как создаем и деплоим контент и как его локализуем.
Для решения задач документирования мы используем генератор статических сайтов Hugo (markdown + Go templates + YAML) и Gitlab CI/CD. Статические страницы документации собираются из шаблонов и публикуются в HTML на 6 языках. Каждый шаблон описывает логику сборки страницы в соответствии с типом контента. Для локализации документации используется подход Continuous localization, который реализован через связку Gitlab CI/CD + Serge + Smartcat.
Доклад будет интересен техническим писателям, разработчикам и менеджерам проектов, которым необходимо решать схожие задачи документирования.
Видео
Посмотрели доклад? Понравился? Напишите комментарий! Не согласны? Тем более напишите.
Презентация
Примечания и ссылки