Создание системы документирования, или как в Cloud.ru от «ворда» к docs as code за месяц переходили. Часть 2

Моя цель - предложение широкого ассортимента товаров и услуг на постоянно высоком качестве обслуживания по самым выгодным ценам.

Прежде чем перейти к статье, хочу вам представить, экономическую онлайн игру Brave Knights, в которой вы можете играть и зарабатывать. Регистируйтесь, играйте и зарабатывайте!

Привет, Хабр! На связи снова Юрий Никулин. В первой части статьи я рассказывал, почему в Cloud.ru решили перейти на doc as code и какой технологический стек мы выбрали. В этой части поделюсь самим процессом — расскажу, как настраивали, тестировали и внедряли новую систему и что из этого вышло.

На старте

Итак, напомню, что для реализации docs as code мы выбрали такой технологический стек: 

  • reStructuredText — язык разметки.

  • GitLab — система версионирования исходников.

  • Visual Studio Code — редактор исходников.

  • Sphinx — система сборки для генерации статических страниц HTML.

Всё, что было у нас на тот момент — горящий дедлайн 4 недели, руководитель документирования (я), 5 техписателей и двое разработчиков на парт-тайм. И нам был нужен план

Источник: https://habr.com/ru/companies/cloud_ru/articles/767014/


Интересные статьи

Интересные статьи

Хабр, привет! Меня зовут Витя, я работаю системным аналитиком, сегодня хочу рассказать про такой обязательный навык аналитиков, как проектирование процессов. Думаю, что каждый, кто будет работать на п...
В этой части я коротко расскажу о мотивах и с чего начиналась разработка. Меня зовут Алексей и я желаю вам приятного чтения! Идея Тут все произошло более чем спонтанно зимнем вечером ...
В этом посте я хочу рассказать о системе балансировки нагрузки VMware NSX Advanced Load Balancer (by Avi Networks), или NSX ALB. Чуть больше года назад компания VMware купила компанию Avi...
Из-за перехода на удаленку в небольших компаниях часто возникают проблемы с телефонной связью. Обычно такие фирмы сидят в арендованных офисах, а услуги телефонии им оказывает бизн...
Даже сегодня люди по-прежнему продолжают создавать новые игры для старых консолей. Мы называем их «homebrew». Иногда это способ реализовать детскую мечту о создании игры для консоли, на которой...