Size: a a a

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

2019 November 12

NV

Nick Volynkin in DocOps-сообщество
Пишут что «дружная команда, интересные задачи и большие перспективы».
источник

RG

Ramil G in DocOps-сообщество
Angela
прошу совета, поплясав со связкой "shpinx-doc & rst и локализация через po/mo файлы", мы упёрлись в ограничения сфинкса:

- нет нативной поддержки версионности при подключении локализации с вышеуказанной схемой, т.е. на одном языке работает, на двух одновременно - нет;
- встроенный поиск ищет не по html-страничкам, а по rst исходникам, и выдаёт всё, включая закомментированные строки, причём, если поиск на английском, то превью отображается на русском, что не гуд;
- проблемы с кастомизацией pdf-файлов как на англ языке, так и в целом с любым документом, который билдится сфинксом

есть ещё пара некритичных мелочей.

По сему решили подыскать другую площадку для управления контентом и вёрстки сайта, хотелось бы иметь версионирование, локализацию, нормальный поиск и выгрузку в пдф из коробки в нормальном виде. Такие решения/платформы вообще существуют?
Antora
источник

NV

Nick Volynkin in DocOps-сообщество
Ramil G
Antora
Там всё плохо было с локализацией в последний раз, когда я смотрел. Месяц назад.
источник
2019 November 13

FM

Fox Mulder in DocOps-сообщество
Lana
Например, "Не надо расписывать все-все задачи, постарайтесь уложиться в пару предложений. Если будет слишком длинно — мы сократим по своему усмотрению", ну и поле вилка обязательное
Кратко:
И другие поручения руководителя.
источник

KC

Kseniya Chudakova in DocOps-сообщество
Нац Нац
Подымим техрайтошную с колен
девиз канала
источник
2019 November 14

IA

Igor Afanasyev in DocOps-сообщество
Angela
прошу совета, поплясав со связкой "shpinx-doc & rst и локализация через po/mo файлы", мы упёрлись в ограничения сфинкса:

- нет нативной поддержки версионности при подключении локализации с вышеуказанной схемой, т.е. на одном языке работает, на двух одновременно - нет;
- встроенный поиск ищет не по html-страничкам, а по rst исходникам, и выдаёт всё, включая закомментированные строки, причём, если поиск на английском, то превью отображается на русском, что не гуд;
- проблемы с кастомизацией pdf-файлов как на англ языке, так и в целом с любым документом, который билдится сфинксом

есть ещё пара некритичных мелочей.

По сему решили подыскать другую площадку для управления контентом и вёрстки сайта, хотелось бы иметь версионирование, локализацию, нормальный поиск и выгрузку в пдф из коробки в нормальном виде. Такие решения/платформы вообще существуют?
А что если развязать локализацию и Sphinx? Т.е. вместо попытки собирать многоязычную доку средствами самого Sphinx (как я понял вышеописанное), пойти другим путем: делать локализацию rst-файлов, и из них делать независимые сборки документации под каждый язык? Если отбросить локализацию и представить, что язык всего один, Sphinx сам по себе устраивает?
источник

ЕД

Егор Доронин in DocOps-сообщество
Это хороший сценарий. Для локализации тогда можно использовать Trados с нормальным управлением проектом, терминологией и версиями локализации. Плюс возможность работать над локализацией не одному человеку. Есть трейдофф: этот шаг назад от CI/CD обратно к кровавому энтерпрайзу. Потому что при изменении исходной языковой версии придется заново перелопачивать проект. С другой стороны, 99% текстовых единиц уже будут в памяти перевода, так что работы минимум.
источник

ЕД

Егор Доронин in DocOps-сообщество
Забыл еще один минус - Традос далеко не бесплатный
источник

IA

Igor Afanasyev in DocOps-сообщество
Егор Доронин
Это хороший сценарий. Для локализации тогда можно использовать Trados с нормальным управлением проектом, терминологией и версиями локализации. Плюс возможность работать над локализацией не одному человеку. Есть трейдофф: этот шаг назад от CI/CD обратно к кровавому энтерпрайзу. Потому что при изменении исходной языковой версии придется заново перелопачивать проект. С другой стороны, 99% текстовых единиц уже будут в памяти перевода, так что работы минимум.
Для локализации при этом можно использовать вообще любую систему 😉
источник

NV

Nick Volynkin in DocOps-сообщество
Igor Afanasyev
А что если развязать локализацию и Sphinx? Т.е. вместо попытки собирать многоязычную доку средствами самого Sphinx (как я понял вышеописанное), пойти другим путем: делать локализацию rst-файлов, и из них делать независимые сборки документации под каждый язык? Если отбросить локализацию и представить, что язык всего один, Sphinx сам по себе устраивает?
Для локализации rst-файлов нужно по контенту построить синтаксическое дерево (AST) и из его узлов вытащить строки. Это уже реализовано в Sphinx, в ином сценарии придётся делать это с нуля.
Мы для локализации используем стандартные sphinx-build -M gettext  и sphinx-intl, а потом собираем файлы .po в один файл .xliff, который понимает в том числе Trados.
источник

NV

Nick Volynkin in DocOps-сообщество
Там третья и, возможно, вторая проблема были связаны с ошибкой в коде переводной локали. @exebeeche, получилось починить это?
источник

IA

Igor Afanasyev in DocOps-сообщество
да, rst не самый удобный формат для парсинга, но я бы попробовал pandoc-ом конвертить его в HTML, локализовать HTML, а потом тем же pandoc-ом конвертить обратно в rst. я попробовал — вроде даже работает
источник

NV

Nick Volynkin in DocOps-сообщество
Igor Afanasyev
да, rst не самый удобный формат для парсинга, но я бы попробовал pandoc-ом конвертить его в HTML, локализовать HTML, а потом тем же pandoc-ом конвертить обратно в rst. я попробовал — вроде даже работает
А зачем, если всё работает и так? )
источник

IA

Igor Afanasyev in DocOps-сообщество
ну вот у кого-то выше не работает в мультиязычном варианте. а sphinx умеет просто из .po собирать локализованные rst?
источник

NV

Nick Volynkin in DocOps-сообщество
Igor Afanasyev
ну вот у кого-то выше не работает в мультиязычном варианте. а sphinx умеет просто из .po собирать локализованные rst?
Из коробки он умеет из оригинального rst  и .po собирать разные выходные форматы. Прямо в ещё один rst с переведённым текстом из коробки не умеет, но можно научить.
источник

NV

Nick Volynkin in DocOps-сообщество
Но это, мне кажется, редкий и неосновной сценарий. Нужен, когда выходные форматы производятся чем-то иным, чем Sphinx, и при этом нужна локалиация, которую всё равно проще делать через Sphinx.
источник

A

Angela in DocOps-сообщество
Nick Volynkin
Там третья и, возможно, вторая проблема были связаны с ошибкой в коде переводной локали. @exebeeche, получилось починить это?
мы пока попробовали через движок с темы readthedocs, там нормально всё билдится, но англ язык надо выделять в отдельную репу в рст формате
у нас с локализацией нет проблем, и, кстати, поиск в англ версии с показом русских превьюшек это проблема кеша на cloudflare, где у нас инфраструктура лежит
источник

NV

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

A

Angela in DocOps-сообщество
Nick Volynkin
Из коробки он умеет из оригинального rst  и .po собирать разные выходные форматы. Прямо в ещё один rst с переведённым текстом из коробки не умеет, но можно научить.
версионность из коробаса не работает))
источник

A

Angela in DocOps-сообщество
и стили под пдф надо перепиливать под латех сборку, дефолтная версия не айс
источник