Серия «Diplodoc»

Теперь я точно понял, почему не работало!

Ну как понял, мне подсказали в чате сервиса. У меня была установлена старая версия их платформенной библиотеки для работы основных функций, diplodoc/cli и старая 14 версия Node.js.
По рекомендации обновил diplodoc/cli, запускаю проект и начали сыпаться ошибки, среди которых была ошибка об устаревшей версии Node.js. Без замедлений скачал новую 20 версию, обновил проект и запустилось все с кайфом.

Теперь со спокойной душой начну переносить документацию MarketDB на новую версию.

Немыкин.Продакшн
#Diplodoc #Документация #Разработка

Я понял, почему это не работало... Но оно так и не заработало.

Оказывается, у меня установлена 20 версия Node.js, а для правильной работы необходима 14 (если верить ошибкам, который бросают зависимости при запуске). С Node.js опыта не имею, поэтому есть сложности с чтением ошибок.
Возился с тем, чтобы установить сразу несколько версий и переключаться между ними. Из коробки так делать нельзя и нужна дополнительная утилита nvm. Это узнать мне помог ответ на StackOverflow. Как всегда, есть свои особенности с командной строкой у Windows, поэтому и тут не все так просто, благо есть Git BASH с командной строкой Linux. Поставил последнюю 14 версию (что тоже вроде повлекло ошибки и нужна не последняя 14), переключился на нее и ничего не произошло, только посыпались ошибки с выполнением npm. Вот так я возился, возился и к четкому результату так и не пришел.

Решил залить в свой GitHub, задеплоил и получилось ровно то, что я хочу, но локально не запускается. https://truedranik.github.io/diplodoc-example/index.html
На первом скрине то, что запускается, на втором - билд на GitHub, при этом это один и тот же проект.

Нашел в гите и решил посмотреть доку самого сервиса Diplodoc, нашел еще доку Yandex.Cloud, но они тоже странно запускаются.
Поэтому я сдался и написал в чат сервиса в телеге, а пока отдохну и переключусь изучать Yandex DataSphere.

Если у вас есть идеи, рекомендации или предложения - обязательно напишите мне об этом,

Немыкин.Продакшн
#Diplodoc #Документация #Разработка

Пост о том, как я разбирался с Diplodoc.

Это платформа для создания технической документации в концепции Docs as Сode с открытым исходным кодом.

Разбирался и продолжаю разбираться как в личных целях, так и для MarketDB, так как нынешняя документация откровенно не очень.

Узнал об этом сервисе на (Не)Конференции от Яндекса, где директор платформы Diplodoc презентовал возможности продукта. Кстати, все доки Яндекса написаны с помощью этого сервиса.

Так вот, лектор рассказывал, как просто, легко и удобно у них делать доку, что они придерживаются популярных принципов построения кода: KISS, DRY и т.д.
Только есть забавный момент. У разработчиков сервиса для легкого написания документации местами не очень понятная или неполноценная документация, такая вот боль, ирония и правда.

Не буду нагнетать, в целом все нормально, уверен разобраться можно. Документация Yandex.Cloud выглядит супер приятно и все это с помощью сервиса Diplodoc. Дополнительно стоит овладеть знаниями CSS и, возможно, JS, хотя, как утверждают разработчики сервиса, обойтись можно и без этих знаний.

А пока что можете посмотреть, что у меня получается: https://github.com/TrueDranik/diplodoc-example.

(То, что на скрине почему-то не работает, как должно, хотя написано согласно документации)

Немыкин.Продакшн
#Diplodoc #Документация #Разработка