Edit

Внести вклад и помочь нам сделаться лучше

Требуются переводчики! Мы ищем переводчиков чтобы помочь перевести спецификацию для каждого!

Помогите улучшить документацию всех участников!

Спасибо за ваш интерес к проекту! Приветствуются пул-реквесты улучшений любого уровня: от небольших правок до нового раздела, помогите нам сделать проект лучше

Все исходные коды доступны на сайте github.com/all-contributors/all-contributors

Committing to an all-contributors repo

We use the angular commit convention for commits that are used for an automated changelog generation, so it would be advisable to respect that. If you're not used to it or are afraid to mistype a commit, you can run npm run commit or git cz (if you have installed commitizen) which would take you through a few questions and write the commit for you.

Редактирование содержимого

Подсказка: Каждая страница имеет кнопку Редактировать наверху, нажав на неё, вы сразу перейдете к исходному коду этой страницы на GitHub

Once on a file, click the 'pencil' icon to easily edit the file inline

Пример того, как редактировать страницу

Переводы

Crowdin

Our translations are managed through crowdin. Вы можете помочь нам, перейдя по ссылке проект Crowdin и предлагая переводы. If you like, comment on this issue to let us know you're helping or if you have any queries!

When translating, anything that has the XPATH @href, @src etc mustn't be translated. Такие вещи, как code, также не должны быть переведены. Это приведет к ошибке 404 в проекте. See the below image for an example: Contribute to translating

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

Как использовать?

Войти в Crowdin

  1. Перейдите по ссылке проекта crowdin, затем зарегистрируйтесь и/или войдите.
  2. Присоединяйтесь к проекту "All Contributors" и вуаля!

Перевод строк

  1. Перейдите к проекту Crowdin.
  2. Нажмите на флаг языка, для которого вы хотите перевести документацию.
  3. Нажмите на любой файл *.md, который не полностью переведен (т.е. в котором нет 100% с правой стороны)
  4. Напишите ваш перевод в поле "Enter translation here" (которое соответствует переводу текста в поле "SOURCE STRING" выше), затем нажмите "SAVE"
  5. Только для корректоров: вы можете либо утвердить предложения перевода (независимо от того, сделано ли это вами или кем-то другим), которые вы найдете в "[LANGUAGE] TRANSLATIONS" , нажав на :ballot_box_with_check: или удалить их, нажав на иконку :wastebasket:.

Change deployments

After you translate strings in any given language, you won't see those changes appearing live until the master branch was updated followed by a successful deployment.

Поиск

Search is by algolia, the configuration is at https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json

Запустить сайт локально:

Все участники используют Docusaurus для ведения нашего веб-сайта документации. For more info visit the Docusaurus Website

Начать работу локально:

  • yarn install
  • yarn start
  • перейдите на http://localhost:3000 (обновите страницу для отражения изменений)

Добавить себя в качестве участника

Чтобы добавить себя в таблицу участников, следуйте инструкциям по использованию бота ;).

← КонфигурацияКодекс поведения →