Search
Write a publication
Pull to refresh

Comments 4

невозможно организовать участие сообщества в переводе документации.


Интересно было бы услышать, почему не подходит решение хранить все на github/gitlabe а показывать в каком-то таком виде: docs.docker.com/get-started

Там и версии есть, и кнопочка Edit. Понятно, надо «смотрелку» для начала найти, но, по-моему, это не есть большая проблема.

Может быть не понял вопрос, но именно это и реализовано? Т.е. документация хранится вся на https://github.com/iondv/docs-ru исходная и переводы на https://github.com/iondv/docs-l18n. При этом к docs-l18n подключена веб-систем для переводов Weblate (это чтобы в обычных редакторах не редактировать и не пушить в репозиторий — хотя это тоже вполне возможно, т.е. веблейт он рядом, а не вместо).
При этом для смотрелки подключена readthedocs которая билдит из файлов rst с помощью sphinx html странички (но кстати и pdf-ки и epub тоже) — это можно и на сервере делать и выкладывать файлы под любой веб-сервер. На readthedocs на каждой страничке есть ссылка на редактирование оригинала на github.
Я к сожалению не знаю, что за системе у docker для документации используется.

Да, теперь понял. Несколько сбила с толка фраза «То, что можно собирать документацию и безвозмездно хостить её прямо на readthedocs это больше бонус, хотя и приятный».

Если хостить Weblate самим, то собирать документацию и хостить статичные html-ки собранные sphinx конечно уже не сложно, больше было про это.

Sign up to leave a comment.

Articles