Коллеги, вопрос по sphinx. Не знаете ли быстрого способа вставить все тексты из инклюдов в основной текст?

Господа и дамы, вакансии для тех райтеров можно в чат скидывать или тут как то иначе принято?

Вопрос снят )

В @technicalwriters можно

Покопал поглубже. Крайне интересно. Действительно, можно собрать документ в Microsoft Office. Даже в докере (что правильно, т.к. сборка должна осуществляться в чистой среде, а каждый раз устанавливать MS Office на чистую машину тяжеловато). Естественно, хостовая машина должна быть на винде. И gitlab, и github такую возможность дают.

Но есть исключительно интересный документ https://support.microsoft.com/en-us/topic/considerations-for-server-side-automation-of-office-48bcfe93-8a89-47f1-0bce-017433ad79e2.

В нём две важные мысли.

1) Лицензионная политика предполагает наличие лицензии у клиента, который обращается к MS Office
2) Огромное количество слов сказано относительно того, что не надо использовать MS Word для работы на сервере

Конвертеров docx в pdf много. В основном, платные. Исходя из моего понимания, как устроена конвертация, на отлично это может делать только MS Word. Очень много нюансов. Поэтому, всё же ждём от Microsoft какого-то движения в нужном направлении. Их может быть много. Пока, с моей точки зрения, Microsoft -- активный борец против DocOps

А в версии 365?

Можно создать такой сервис. Человек ставит специальную программу на десктоп. И, когда идёт спать (или просто не работает за компьютером), оставляет его включенным. Эта программа берёт из входящей очереди файл, пересохраняет как pdf и загружает в исходящую очередь. Мне кажется, лицензионному соглашению противоречить не будет. Каждая конвертация, например, может стоить 10 центов.

В документе выше указано следующее. Office Products Access 2010 Excel 2010 Microsoft Outlook 2010 PowerPoint 2010 Microsoft Word 2010 Project Professional 2010 Project Standard 2010 Visio Standard 2010 Visio Professional 2010 Microsoft OneNote 2010 InfoPath 2010 Access 2013 Excel 2013 InfoPath 2013 Outlook 2013 PowerPoint 2013 Visio Professional 2013 Visio Standard 2013 Word 2013 Access 2016 Excel 2016 Outlook 2016 PowerPoint 2016 Visio Professional 2016 Visio Standard 2016 Word 2016 Office 365

Поэтому, и в 365. Но Microsoft делает неожиданные шаги. Возможно в 366-й версии будет что-то изменено

@Nick_Volynkin привет, у вас в тарантуле дока изменилась? визуально раньше вроде по другому было. можешь рассказать, что теперь используете?

Привет. Мы просто сделали новый дизайн доки. Там ещё не всё готово даже, будет ещё лучше :)

Если тоже хотите редизайн доки, могу поделиться контактами :)

не, пока не актуально

это сложно сделать дизайн документации

Да. И мы на этом не остановимся, я думаю

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

Здравствуйте.В группе курса по технической документации кто-то посетовал, что практически нет сообществ и один из организаторов поделился каналами)

Коллеги, я в нашей компании совершил переход апи на openapi с api first  подходом и стало ясно, что добрая половина нашей написанной руками документации должна уехать в структурированное описание самого апи.


Изменение для меня так просто скачкообразное.

Хотел что обсудить: сейчас явно встанет вопрос о том, чтобы связывать жесткое структурированное openapi и довольно свободно написанную руками документацию.

Это нужно по разным причинам: понять, что из референсов мы не описали в гайдах и какие вообще вещи нужны для того или иного гайда.

А у вас такое реализовано?

Есть автоматический учет ссылок между документацией апи и текстовыми гайдами.

Скрипт на языке, на котором удобно парсить json, недавно делал подобное для postman - сравнивать покрытие openapi тестами

да, openapi создает очень удобный формат описания, пригодный для обработки.

А что вы с постманом интегрировали? Он вообще к интеграции пригоден?