egret/team-docs
1
0
Fork 1
forked from docs/team-docs
Code Pull requests Wiki Activity

write process updates

Browse source
This commit is contained in:
Test Lab 2023-03-16 20:33:03 +00:00
commit bc77d95bbb
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
modules/ROOT/pages/contributing-docs/tools-gitlab-howto.adoc
View file

@ -3,7 +3,7 @@ Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revdate: 2023-03-16
[abstract]
To make changes in Docs page hosted on GitLab, you have a built-in web editor that makes your first contribution easier than ever. Start editing documentation on GitLab Web IDE that you can launch in one click.
To make changes in Docs page hosted on GitLab, you have a built-in web editor that makes your first contribution easier than ever. Start editing documentation on GitLab Web IDE that you can launch in one click. You do not need special permissions or write access.
- There is no need to install apps or clone repos on your local computer, or run git commands in terminal.
@ -17,9 +17,9 @@ To make changes in Docs page hosted on GitLab, you have a built-in web editor th
If you found something on a Docs page you want to edit, navigate to the top right and locate three buttons.
On left of the buttons, you see the Fedora release (e.g., "F36") to which the Docs page you have opened relates to. Docs pages relate to a specific Fedora release, although changes/updates can apply to several releases' Docs pages. If the latter is the case just choose any version that needs the change/update. If you do not know what version the update applies to, then ignore it for the time being.
On left of the buttons, you see the Fedora release (e.g., "F36") to which the Docs page you have opened relates to. Docs pages relate to a specific Fedora release, although changes/updates can apply to several releases' Docs pages. If the latter is the case, just choose any version that needs change or update.
The left button forwards to the version history of the opened Docs page and is not relevant for you. The middle button "edit the page" opens up a source file for change or update. The right button "report an issue" is when you report any change or update required. Click the middle ("edit the page") button to make corrections:
The left button forwards to the version history of the opened Docs page as a reference. The middle button *edit the page* opens up a source file for change or update. The right button *report an issue* is when you report any change or update required. Click the middle *edit the page* button to make corrections.
|===
a|image::1CUT-changeIdentified.png[align="center",role=black-border]
@ -37,7 +37,7 @@ If you have already a GitLab account and want to link it to your Fedora account,
a|image::2-GitLabSignin.png[align="center",width=940,role=black-border]
|===
NOTE: From GitLab 15.7, a new default Web IDE editor was introduced. This guide focuses on the new <<web-ide-editor,Web IDE editor>>. Alternatively, you can use the simple https://docs.gitlab.com/ee/user/project/repository/web_editor.html#edit-a-file[Web Editor]. When using the Web Editor, follow the steps on the related https://docs.gitlab.com/ee/user/project/repository/web_editor.html#edit-a-file[GitLab guide] instead of the <<web-ide-editor,Web IDE editor>> section here, and then proceed directly to the <<merge-request,Merge request>> section below.
NOTE: From GitLab 15.7, a new Web IDE editor was introduced. This guide focuses on the new <<web-ide-editor,Web IDE editor>>. Alternatively, you can use the simple https://docs.gitlab.com/ee/user/project/repository/web_editor.html#edit-a-file[Web Editor]. When using the Web Editor, follow the steps on the related https://docs.gitlab.com/ee/user/project/repository/web_editor.html#edit-a-file[GitLab guide] instead of the <<web-ide-editor,Web IDE editor>> section here, and then proceed directly to the <<merge-request,Merge request>> section below.
=== Launch Web IDE and fork the project
@ -55,19 +55,19 @@ The *Fork* button appears only the first time you contribute to the repository o
A fork is a personal copy of the repository, which you create in your namespace.
|===
a|image::4-EditFork.png[align="center",width=940,role=black-border]
|===
==== Forked a project before
If you have a forked repository (e.g., during an earlier contribution), you will be forwarded automatically to the next step without the *Fork* button.
If you do not launch Web IDE from your fork, *edit fork in Web IDE* button will appear in lieu of the *Open in Web IDE* button. Then you will be prompted to *go to fork* and checkout to your fork.
CAUTION: If you have forked the repository before, and if you have already the related branch, GitLab will not check if your fork’s branch is up to date. It will forward you to the respective file in the related branch of your fork even if this file is no longer up to date. GitLab knows about the problem and it is planned to solve this problem with the 15.10 release by the end of March 2023. Until then, please keep in mind that you will not see a *Fork* button or a *Create branch* button: in this case, check if your file is up to date before start working.
|===
a|image::4-EditFork.png[align="center",width=940,role=black-border]
|===
CAUTION: If you have forked the repository before, and if you have already the related branch, GitLab will not check if your fork's branch is up to date: it will forward you to the respective file in the related branch of your fork even if this file is no longer up to date. GitLab knows about the https://gitlab.com/gitlab-org/gitlab/-/issues/330243[problem] and it is planned to solve this problem with the release of the https://gitlab.com/groups/gitlab-org/-/milestones/85#tab-issues[15.10 release] by the end of *March 2023*. Until then, you have to keep careful if you see neither a "Fork" button nor a "Create branch" button: in this case, check if your file is up to date before start working! If it is not, wait for the 15.10 release, or if you know how to: update your fork, or remove it & re-fork the repository. Alternatively, get in touch with the Docs team https://chat.fedoraproject.org/#/room/#docs:fedoraproject.org[here] or https://discussion.fedoraproject.org/[here]!
=== Write, preview, edit and repeat
Now, make the necessary changes in Web IDE. Please refer to the style guide to write with consistency: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/style-guide/
@ -77,13 +77,13 @@ a|image::webuibeta-1.png[align="center",width=940,role=black-border]
=== Commit and push your changes to a branch
Once you've finished, click on both the branch (source control) icon and the file (underneath 'Commit & Push' button) to view your changes. Type a commit message and click "Commit & Push":
Once you've finished, click on both the branch (source control) icon and the file (underneath *Commit & Push* button) to view your changes. Type a commit message and click *Commit & Push*.
|===
a|image::webuibeta-2a.png[align="center",width=940,role=black-border]
|===
Click on *Yes Commit to a new branch*:
Click on *Yes Commit to a new branch*.
Your branch (source branch) will be deleted when merge request is accepted. A checkbox for this option is selected by default to avoid stale branch and resultant merge conflict.