Как вносить простые правки
| Многие репозитории теперь перенесены на Fedora Forge. См. обновленное руководство Редактирование одной страницы в Forge. |
Чтобы вносить изменения на страницу документации, размещенную на GitLab, у вас есть встроенный веб-редактор, который упрощает ваш первый вклад. Начните редактирование документации в GitLab Web IDE, который можно запустить одним щелчком. Вам не нужны специальные разрешения или права на запись в исходный проект.
-
Нет необходимости устанавливать приложения или клонировать репозитории на локальный компьютер или выполнять команды Git в терминале.
-
Нет риска что-либо сломать.
-
Это руководство для репозитория, размещенного на GitLab.
Как редактировать документ с помощью Web IDE
Шаг 1. Выберите страницу для редактирования
-
Найдите страницу документации, которую хотите отредактировать.
-
Перейдите в правый верхний угол и найдите три кнопки.
-
Нажмите среднюю кнопку edit the page, чтобы внести исправления.
| Левая кнопка перенаправляет к истории версий открытой страницы документации в качестве справки. Правая кнопка report an issue используется, когда вы сообщаете о необходимости какого-либо изменения или обновления. |
|
|
-
Войдите в свою существующую учетную запись GitLab
-
Используйте SAML-ссылку, чтобы связать свою учетную запись с FAS
-
Вы будете перенаправлены и при необходимости вам будет предложено ввести учетные данные FAS
-
Предоставьте разрешение Fedora
Создайте учетную запись, если у вас ее еще нет (см. изображение ниже).
|
| Это руководство для участников знакомит с новым Web IDE, представленным в выпуске GitLab 15.7. Руководство также отражает недавнее изменение о том, как обновить форк. |
Шаг 2. Создайте свой проект (копию)
Нажмите кнопку Open in Web IDE. В качестве альтернативы нажмите . (точку) на клавиатуре, чтобы запустить Web IDE.
|
Создание форка проекта в первый раз
Нажмите кнопку Fork.
Кнопка Fork появляется только при первом внесении вклада в репозиторий данной страницы документации. Если вы вносите вклад в проект Fedora впервые и у вас нет прав на запись в репозиторий, в который вы хотите внести вклад, вам необходимо создать форк проекта.
Форк — это личная копия репозитория, которую вы создаете в своем пространстве имен.
|
Если вы уже создавали форк проекта ранее
Если у вас уже есть форк проекта, вы будете автоматически перенаправлены к следующему шагу без кнопки Fork.
Если вы не запускаете Web IDE из своего форка, вместо кнопки Open in Web IDE появится кнопка edit fork in Web IDE. Затем вам будет предложено go to fork и переключиться на ваш форк.
-
Перейдите в свой форк проекта.
-
Проверьте статус вашего форка под кнопкой Web IDE.
Если ваш форк показывает Up to date with the upstream repository, перейдите к шагу 3 в Web IDE.
Если ваш форк отстает от вышестоящего репозитория, вы увидите текст в интерфейсе, указывающий, насколько ваш форк отстает.
-
Нажмите кнопку Update fork.
-
Форк будет отображать Up to date with the upstream repository
-
Кнопка Update fork исчезает после обновления форка
Шаг 3. Создайте новую ветку (версию)
В вашем форке проекта создайте новую ветку и переключитесь на нее, следуя шагам ниже.
-
В строке состояния внизу в левом нижнем углу нажмите текущее имя ветки (обычно main).
-
В раскрывающемся списке выберите Create new branch….
-
Введите имя ветки, соответствующее задаче.
-
Нажмите Enter.
-
Переключитесь на новую ветку. Нажмите Да во всплывающем окне.
Вы уверены, что хотите переключиться на <имя-ветки>? Все несохраненные изменения будут потеряны.
Шаг 4. Отредактируйте и сохраните изменения
Теперь внесите необходимые изменения в Web IDE. Для согласованности написания обратитесь к Руководству по стилю документации
После завершения выберите кнопку управления исходным кодом и нажмите на файл под changes ниже кнопки Commit & Push, чтобы просмотреть свои изменения.
Введите сообщение коммита и нажмите Commit & Push. Нажмите Нет, чтобы зафиксировать в существующей ветке.
Шаг 5. Создайте запрос на слияние (MR)
В правом нижнем углу вы найдете три варианта — create MR, Go to project, Continue working.
-
Нажмите Create MR, чтобы создать запрос на слияние.
-
Отредактируйте заголовок и описание страницы.
-
Прокрутите вниз до синей кнопки Create merge request и нажмите ее.
| Вариант Go to project подходит, когда вы сделали небольшие коммиты поэтапно и хотите объединить их в один. Continue working — когда вы хотите делать небольшие коммиты по подзадачам. Если вы выберете Create MR, интерфейс перейдет к запросу на слияние. |
Если запрос на слияние успешен, вы увидите следующий результат в средней нижней части запроса на слияние.
Готово к слиянию участниками, имеющими права на запись в целевую ветку.
Шаг 6. Рассмотрение
Ваш запрос будет рассмотрен командой документации. Вы можете ожидать одного из следующих действий.
-
Рецензенты просят вас пересмотреть ваши изменения
-
Одобрить
-
Отклонить и закрыть MR с обоснованием
В любом случае комментарии в MR способствуют сотрудничеству между участниками и рецензентами. Каждый может учиться на этих комментариях и исправлениях.
После одобрения вашего MR процесс завершен.
Спасибо за ваш вклад!
Want to help? Learn how to contribute to Fedora Docs ›