EasyXrayУчастие в проекте
Как внести вклад в EasyXray и помочь с переводом этой документации.
EasyXray развивается силами сообщества. Мы рады вкладу как в саму панель, так и в эту документацию.
Поддержать проект
EasyXray — бесплатный проект с открытым исходным кодом, который создаётся и сопровождается открыто. Если он вам полезен, вот как можно помочь:
- Поставьте звезду репозиторию и расскажите о проекте всем, кто запускает сервер Xray.
- Сообщайте об ошибках и шероховатостях с понятными шагами воспроизведения.
- Переводите документацию — см. ниже.
- Поддержите проект через Ko-fi, если хотите помочь сопровождающему напрямую.
- Присоединяйтесь к каналу сообщества проекта X-UI — @XrayUI, которым пользуются и пользователи EasyXray, чтобы следить за новостями и помогать другим.
Внести вклад в EasyXray
- Прочитайте файл
CONTRIBUTING.mdпроекта в репозитории. - Создавайте issue для багов и предложений по новым возможностям с понятными шагами воспроизведения.
- Используйте Conventional Commits и делайте pull request'ы сфокусированными.
Перевести документацию
Этот сайт создан с расчётом на перевод. Контент находится в каталоге
content/docs/<locale>/ (en, fa, ru, zh), а непереведённые страницы
откатываются к английскому, поэтому переводить можно постепенно.
Скопируйте страницу
Скопируйте страницу из content/docs/en/... по тому же пути в каталог вашей
локали, например content/docs/fa/guide/installation.mdx.
Переводите только текст
Переводите тело страницы и поля frontmatter title/description. Не
переводите код, команды, имена переменных окружения, названия протоколов и
ссылки для подключения.
Учитывайте направление текста
Персидский язык (fa) отображается справа налево. Оставляйте блоки кода и ссылки
слева направо (макет уже учитывает это) и проверяйте страницу в обоих
направлениях.
Отсутствие страницы в вашей локали — это нормально: она откатывается к английскому, а не выдаёт ошибку 404. Сначала переводите самые посещаемые страницы (установка, первый вход, REALITY).