Получи случайную криптовалюту за регистрацию!

DocOps

Логотип телеграм канала @docops — DocOps D
Логотип телеграм канала @docops — DocOps
Адрес канала: @docops
Категории: Технологии
Язык: Русский
Количество подписчиков: 4.78K
Описание канала:

Writing about work, Developer Relations and Developer Experience, mentorshiop, conferences, documentation, and everything that I work and live with.
Author: @nick_volynkin
Mentorship: https://getmentor.dev/mentor/nikolay-volynkin-186

Рейтинги и Отзывы

4.33

3 отзыва

Оценить канал docops и оставить отзыв — могут только зарегестрированные пользователи. Все отзывы проходят модерацию.

5 звезд

1

4 звезд

2

3 звезд

0

2 звезд

0

1 звезд

0


Последние сообщения 8

2020-12-09 08:30:43 Таня Фокина, UX-писатель из ЦФТ, рассказывает о своей профессии и решает задачки в канале @rishavant. С Таней мы давно знакомы, вместе работали в переводческой артели «Надмозг» и в ПК конференции DocFactor. Таня шарит, так что канал я очень рекомендую. Мне…
1.9K viewsedited  05:30
Открыть/Комментировать
2020-12-08 09:00:16 Таня Фокина, UX-писатель из ЦФТ, рассказывает о своей профессии и решает задачки в канале @rishavant.

С Таней мы давно знакомы, вместе работали в переводческой артели «Надмозг» и в ПК конференции DocFactor. Таня шарит, так что канал я очень рекомендую.

Мне особенно понравился пост про то, как полезно выяснять задачу бизнеса. У писателя по-хорошему не должно быть задачи «написать текст», как и у плотника нет задачи «поиспользовать молоток», а у хирурга «порезать скальпелем». Это всё инструменты, а не задачи.

https://t.me/rishavant/7
2.0K views06:00
Открыть/Комментировать
2020-12-07 09:00:14 Максим Лапшин (Flussonic.com) написал подробный обзор @foliantdocs — комбайна для сборки и публикации документации в веб, PDF, конфлюенс и разные другие форматы. Доки Flussonic теперь собираются именно Фолиантом.

С разрешения автора публикую обзор здесь:

Я перетащил нашу документацию с самописной обертки вокруг ruby markdown на foliant.

Почему вообще возник вопрос о перезде?

* код писал я, причем очень давно и никакого желания дальше его развивать не было
* то, как я генерировал PDF с помощью ruby prawn было мягко говоря по-спартански

По сравнению с mkdocs и прочими фолиант подкупил интеграцией с пандоком, очень важная штука: бесплатно из коробки top-level поддержка PDF.

Чего мне не хватало из коробки в фолианте?

1. переименовывания результирующих файлов из их понятных имен вида live/publish.md в ужасный SEO-транслит potokovaya-peredacha/publikaciya
2. редиректов с человеческих unix-имен на транслит
3. возможности понять, какой урл будет у этой же страницы на другом языке для иконки языка
4. выгрузка кусков конфига из английской документации на диск для автотестов (мы тестируем документацию) и вставка их в русский вариант
5. выгрузка кусков документации в json для вставки их в админку нашего продукта


В целом всё это получилось решить плагинами, один из которых к mkdocs.

С чем возникли проблемы:

1. рубийный маркдаун существенно вольготнее относится к верске, чем питонячий. Пришлось много текста править
2. после рубийной Nokogiri, парсить HTML регекспами в питоне очень грустно. Очень не хватает API по объектному доступу к AST markdown
3. есть некоторая путаница между слоями метаданных фолианта и mkdocs. Вообще хотелось бы чтобы это не было разными вещами
4. процессоры фолианта разрешают падать и идти дальше. Реалии авторов фолианта такие, что им важнее собрать хоть что-то, чем собрать всё корректно. Мне наоборот — ворнинг уже повод упасть и не собирать документацию.
5. Пришлось написать немало кода, который подправлял плохую верстку в наших 3 миллионах символов (280 тыс слов)


Чего отдельно понравилось:

1. глобальное пространство имен анкоров. Ссылаться на уникальное по проекту имя секции — бесценно.
2. упаковка картинок и прочих ассетов в webpack-стиле, это важно
3. ну и вообще то, что люди решили его опенсорснуть и довести до отчуждаемого состояния. Это круто.
2.5K views06:00
Открыть/Комментировать
2020-12-04 18:19:47 Гильдии в Plesk, Xsolla, Miro, РТ МИС и Сбере.

Ребята из разных компаний делятся опытом внутренних гильдий, то есть профессиональных сообществ. Только что сам начал смотреть, ничего не напишу в анонсе. Но гильдии — это отличная тема. У нас их аж несколько: QA, devops, frontend, backend, security, accessibility.

Судя по набору компаний, будет чертовски интересно. Рекомендую.



2.0K views15:19
Открыть/Комментировать
2020-11-17 16:28:16 Вторая мысль в отпуске: я работаю на одной работе 4 года и уже довольно неточно знаю, сколько я на самом деле стою. Пора это проверить. ;)

Если вам нужен человек, который будет внедрять DocOps и писать доки для разработчиков — напишите мне в личку (@nick_volynkin), пожалуйста.
2.6K views13:28
Открыть/Комментировать
2020-11-17 15:50:48 У меня тут заканчивается второй день отпуска, и я постепенно начинаю понимать, что отпуск стоило взять 1) гораздо раньше и 2) на гораздо больший срок, может быть, на месяц.

Берегите себя, друзья. :)
2.3K viewsedited  12:50
Открыть/Комментировать