Size: a a a

DocOps-сообщество

2019 November 14

NV

Nick Volynkin in DocOps-сообщество
Angela
версионность из коробаса не работает))
Тут два аспекта, как я понял.
1. В теме нет нормального селектора версий. Это решается днём работы фронтендера.
2. В самом Sphinx нет способа собрать сразу N веток. Это, имхо, чаще всего не нужно.

Почему второе не нужно: потому что это замедляет сборку. Вместо одной версии нужно собрать N. Ещё и умноженное на количество переводов.
Если очень нужно, то можно написать скрипт-обёртку, который всё это запустит. Ещё нужно будет где-то сохранить метаданные про набор версий, чтобы заполнить список-селектор. Но это тоже не выглядит чем-то сложным.
источник

A

Angela in DocOps-сообщество
Nick Volynkin
Тут два аспекта, как я понял.
1. В теме нет нормального селектора версий. Это решается днём работы фронтендера.
2. В самом Sphinx нет способа собрать сразу N веток. Это, имхо, чаще всего не нужно.

Почему второе не нужно: потому что это замедляет сборку. Вместо одной версии нужно собрать N. Ещё и умноженное на количество переводов.
Если очень нужно, то можно написать скрипт-обёртку, который всё это запустит. Ещё нужно будет где-то сохранить метаданные про набор версий, чтобы заполнить список-селектор. Но это тоже не выглядит чем-то сложным.
спасибо, Ник, да, селектора нет, но наш фронт не разобрался за день, версионность плагином sphinxcontrib-versioning не работает с po/mo файлами, но у нас правда одна репа, переводы лежат не отдельно, а внутри репы с общей докой

и да, нам нужно столько веток с русским и английским языками, сколько версий ПО у нас есть, потому что разные клиенты могут использовать разные версии продукта, и им нужна справка именно под их версию, различия могут быть сильные от релиза к релизу
источник

A

Angela in DocOps-сообщество
скрипт написать не проблема, проблема сбилдить английскую ветку из po/mo файлов конкретно под версионность
источник

FM

Fox Mulder in DocOps-сообщество
Angela
скрипт написать не проблема, проблема сбилдить английскую ветку из po/mo файлов конкретно под версионность
Хороший вход в качестве темы на какой-нибудь яндексовский батон ;)
источник

A

Angela in DocOps-сообщество
Fox Mulder
Хороший вход в качестве темы на какой-нибудь яндексовский батон ;)
я уже отправляла заявку на минигипербатон в декабре по общей теме сфинкса и локализации, но чот ни ответа, ни привета пока)) даже не знаю, готовиться ли
источник

RZ

Roman Zh in DocOps-сообщество
Angela
я уже отправляла заявку на минигипербатон в декабре по общей теме сфинкса и локализации, но чот ни ответа, ни привета пока)) даже не знаю, готовиться ли
В этом году тематика мини-гипербатона похоже тематика Swagger/Open API.
источник

RZ

Roman Zh in DocOps-сообщество
☺ тематика аж два раза
источник

NV

Nick Volynkin in DocOps-сообщество
Angela
скрипт написать не проблема, проблема сбилдить английскую ветку из po/mo файлов конкретно под версионность
Ну там будут разные наборы этих файлов в разных ветках.
источник

RZ

Roman Zh in DocOps-сообщество
Angela
я уже отправляла заявку на минигипербатон в декабре по общей теме сфинкса и локализации, но чот ни ответа, ни привета пока)) даже не знаю, готовиться ли
Вы давно отправляли заявку? Сейчас можно оставить на блиц доклад на Мини-Гипербатон https://forms.yandex.ru/surveys/10015750/
источник

NK

ID:0 in DocOps-сообщество
Известный техписатель из Амазона Том Джонсон сделал крутейшие тесты на квалификацию, а потом разочаровался в них.

Follow-up to 4 Technical Writing Tests Post.
It's been a while since I've written a post that has received so many negative comments as 4 Technical Writing Tests to Screen Candidates. Although many people did like the tests and found them interesting or fun, quite a few people had more negative reactions. As a result, I'm scrapping the idea of multiple choice tests as a way to filter candidates...


Приходите в @docsascode, обсудим.
источник

A

Angela in DocOps-сообщество
Roman Zh
Вы давно отправляли заявку? Сейчас можно оставить на блиц доклад на Мини-Гипербатон https://forms.yandex.ru/surveys/10015750/
я как раз её и заполняла)
источник

RZ

Roman Zh in DocOps-сообщество
Эх, с удовольствием бы послушал ваш доклад.  Будем ждать информации, пока только даты объявлены.
источник

A

Angela in DocOps-сообщество
Roman Zh
Эх, с удовольствием бы послушал ваш доклад.  Будем ждать информации, пока только даты объявлены.
ну связка sphinx-doc&rst достаточно тривиальная и известная) я могла бы рассказать о нашем опыте, о нюансах и тонкостях, и если бы удалось уговорить нашего фронта поучаствовать, было бы здорово вместо рассказать, но пока непонятно, надо ли вообще готовить доклад, надеюсь, не свалится на голову за день до митапа
источник

EO

Evgeniy Osintsev in DocOps-сообщество
Angela
я уже отправляла заявку на минигипербатон в декабре по общей теме сфинкса и локализации, но чот ни ответа, ни привета пока)) даже не знаю, готовиться ли
ну в календаре у них нету такого ивента в декабре
источник

A

Angela in DocOps-сообщество
Evgeniy Osintsev
ну в календаре у них нету такого ивента в декабре
Всем привет,

4 декабря в Москве и 11 декабря в Санкт-Петербурге состоится Мини-Гипербатон, посвященный генерации документации. Докладчики от Яндекса расскажут про Swagger/Open API.

Мы принимаем заявки на Lightning talks (секцию блиц-докладов): будем рады послушать о вашем опыте генерации документации.

Программу мероприятия и открытие регистрации мы анонсируем дополнительно.

Напоминаем, что Мини-Гипербатон — камерное мероприятие для обмена опытом на заданную тему. Рассчитано на небольшое количество гостей и нацелено на живое общение. Для всех, кто не сможет присутствовать, мы выложим видеозаписи докладов.
источник

A

Angela in DocOps-сообщество
инфа с канала
источник

RZ

Roman Zh in DocOps-сообщество
Видно ещё пока готовится мероприятие + мини всё таки.
источник

RZ

Roman Zh in DocOps-сообщество
ID:
Известный техписатель из Амазона Том Джонсон сделал крутейшие тесты на квалификацию, а потом разочаровался в них.

Follow-up to 4 Technical Writing Tests Post.
It's been a while since I've written a post that has received so many negative comments as 4 Technical Writing Tests to Screen Candidates. Although many people did like the tests and found them interesting or fun, quite a few people had more negative reactions. As a result, I'm scrapping the idea of multiple choice tests as a way to filter candidates...


Приходите в @docsascode, обсудим.
Коллеги что думаете по поводу тестирования знаний технического писателя? Возможно вы уже сталкивались с тестирования при приеме на работу?
источник

НН

Нац Нац in DocOps-сообщество
Roman Zh
Коллеги что думаете по поводу тестирования знаний технического писателя? Возможно вы уже сталкивались с тестирования при приеме на работу?
Хватает пообщаться на собеседовании и позадовать околонаводящие вопросы, это не паттерны спрашивать, ясно почти сразу всё про человека, хватает минут 15-20
источник

FM

Fox Mulder in DocOps-сообщество
Roman Zh
Коллеги что думаете по поводу тестирования знаний технического писателя? Возможно вы уже сталкивались с тестирования при приеме на работу?
не сталкивался. Обычно это: нате вот вам тестовое задание про лифт или хттп или вот вам моё портфолио - там я в профиль, анфас и натюрлих.

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