Задача этого проекта — перевести и поддерживать в актуальном состоянии документацию проекта OpenBSD, доступную на сайте https://openbsd.org. Мы уважаем мнение Тео де Раадта о прекращении поддержки переведенных страниц проекта. Но мы также с пониманием относимся и к тем, кто недостаточно хорошо владеет английским. Мы придаем большое значение не только актуальности переведенного материала, но и его точности и простоте изложения.
Если вы решили помочь проекту, но не знаете с чего начать, выберете любой свободный пункт из списка ниже, либо предложите другую помощь, используя issue. Очень нужным и важным является самая обычная вычитка переведенного текста. Не стесняйтесь сообщить о любой ошибке, опечатке и даже самом незначительном недочете в тексте.
Обратите внимание на автоматические проверки устаревших страниц и поломанных ссылок и обновите уже переведенные страницы.
| Материал к переводу | Ответственный | Комментарий |
|---|---|---|
| FAQ#PF_User Shell for Authenticating Gateways (authpf) | Хотите перевести? | |
| FAQ#PF_Packet Filtering | Alexander Naumov | |
| FAQ#PF_Network Address Translation | Alexander Naumov | |
| FAQ#PF_Traffic Redirection (Port Forwarding) | Хотите перевести? | |
| FAQ#PF_Shortcuts For Creating Rulesets | Хотите перевести? | |
| Copyright Policy | Хотите перевести? | |
| Events | Хотите перевести? | |
| sparc64 | Хотите перевести? | |
| 7.6 | Хотите перевести? | |
| FAQ_Upgrade Guide: 7.5 to 7.6 | Хотите перевести? | |
| FAQ#Ports_Porting Guide | Alexander Naumov | |
| FAQ#Ports_Special Porting Topics | Alexander Naumov |
- Каждый git-коммит должен изменять ТОЛЬКО ОДИН html-файл.
- Комментарий к каждому git-коммиту должен содержать версию
оригинального файла (как показано ниже, в квадратных скобках),
который вы переводите.
Без этого тяжело отслеживать и синхронизировать переведенный
материал с оригинальным. Не отправляйте PR, содержащий
git-коммит с комментарием типа
fix typo! Вместо этого комментарий должен быть[1.29] fix typo - security.html. Посмотрите историю коммитов, чтобы стало понятнее. Обратите внимание на CVSweb. Там исходники с номерами версий для каждого файла. Если осилить номера версий файлов не удалось, лучше просто открыть issue. - Списки серверов, их fingerprint и т.д. меняются достаточно часто. Нет необходимости постоянно синхронизировать эти метаданные. При возможности лучше оставить ссылку на оригинальную страницу (можно оставить коротенький коментарий, в зависимости от контекста)
- Я противник дословного перевода. При переводе потратьте какое-то время для понимания смысла идеи, вложенной в то или иное предложение. Постарайтесь передать именно его. Это дает огромный выигрыш в плане понятности материала. Перед тем как отправить pull request перечитайте еще раз свой перевод и спросите себя действительно ли вы понимаете написанное или это просто перевод каждого по отдельности взятого слова.
Авторские права не всегда понятны, но правила OpenBSD достаточно просты — OpenBSD стремится предоставить код, который может быть свободно использоваться, копироваться, который можно изменять, а также распространять для любых целей и абсолютно каждым и нас. HTML-страницы — точно такая же часть "кода" OpenBSD как и исходники программ на C или скрипты, которыми пользуются разработчики. У HTML-страниц точно такие же правила распространения, как и на код самой OpenBSD.
Анонимный CVS позволяет поддерживать локальный репозиторий с исходниками OpenBSD в актуальном состоянии с учетом изменений, сделанных в репозитории OpenBSD.
Для того, чтобы скачать исходники, используйте anoncvs:
cvs -d [email protected]:/cvs get -P www
Зеркало CVS также доступно на GitHub:
git clone https://github.com/openbsd/www
Вы можете выбрать любую непереведенную часть или страницу. Используется кодировка utf-8. Мы рады каждому замечанию, исправлению, предложению лучшей формулировки и т.д. Не стесняйтесь отправлять pull request или просто issue, если у вас появятся какие-то вопросы.
Не забудьте добавить себя в список TODO, чтобы все знали, что эту страницу уже кто-то переводит. Это избавит от повторной работы над одним и тем же материалом.
Переведенный материал распространяется на точно таких же условиях как и оригинал.
Мы используем три скрипта, которые помогают нам в процессе перевода, беря на себя самую рутинную работу.
-
link_update.sh проверяет необходимость обновления ссылок на всех наших переведенных страницах. Если на странице есть ссылка, которая ведет на английскую страницу, а у нас в репозитории уже есть её перевод, скрипт покажет это.
-
broken_links.sh этот shell-скрипт сканирует наш web-проект и отлавливает поломанные ссылки. Его вывод содержит имя отсутствующего html-файла, а также страницу, на которой находится ссылка.
-
comp_version.sh сверяет версии html-страниц в нашем git-проекте с их же версиями в CVS репозитории. Он показыват
OK, если версии одинаковые, или ссылку на web-diff в противном случае.
Скрипты привязаны к Actions, так что запускаются после
каждого git push и их вывод можно просмотреть
в web.