Актуализирование информации о локальной сборке документации

[wtfnukee]

В README.MD есть инструкция по локальной сборке через diplodoc, но она не работает, я проверял на разных машинах, уточнял у технических писателей из Яндекса и техподдержки Клауда. В общем, я написал инструкцию по сборке через Github Actions.

Первая версия взята и доработана из документации Diplodoc

1. В GitHub в форке документации перейдите на вкладку Settings и в меню слева выберите Pages
2. В разделе Build and deployment в выпадающем списке выберите Source - GitHub Actions и в появившемся блоке Static HTML нажмите кнопку Configure. Откроется окно редактирования экшна.
3. В блоке jobs после строки uses: actions/configure-pages@v5 добавьте код

   - name: Build docs
   uses: diplodoc-platform/docs-build-action@v3
   with:
   src-root: '.'

4. Вверху справа нажмите Commit changes..., укажите имя коммита в поле Commit message и нажмите кнопку Commit changes.
5. Перейдите на вкладку Actions. Вверху списка будет ваш последний коммит.
6. Нажмите на название коммита. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью deploy. К ссылке необходимо добавить /_docs-lint (\<username>.github.io/docs/_docs-lint)

Инструкция вполне понятная, но работает 35 минут. Я переписал с нуля файл экшна и теперь документация собирается за 10 минут, открывается по адресу \<username>.github.io/docs, файл лежит здесь https://gist.github.com/wtfnukee/41b674577c61c7098663b8c505298b96. Вся остальная инструкция та же.

I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=ru Billing Id: dn25hre48u0mkd0huvgi

[SerjKanunnikov]

@wtfnukee Привет! Спасибо за ишью! Мы проверим свои инструкции и посмотрим, что может не работать. Я только что проверил на чистой виртуалке с Убунту — дока собирается примерно за 15-20 минут.

И вопрос: 35 минут — это локально или в экшене?

[wtfnukee]

35 минут собирается в экшене

Ошибка была такая, устанавливал как в ридми через

npm i @doc-tools/docs -g

yfm -i docs -o docs-gen

Пробовал на Винде и Федоре чистой, не работало, скрин с федоры

[wtfnukee]

@SerjKanunnikov Я пофиксил документацию в #833, там просто старая версия инструмента была указана

[SerjKanunnikov]

Спасибо!

833 забрали, закрываю ишью