update fork process added with screenshots

This commit is contained in:
hank L 2023-05-13 21:28:55 +00:00 committed by Peter Boy
commit 80151beab9
3 changed files with 24 additions and 9 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

View file

@ -1,6 +1,6 @@
= How to make casual contributions
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revdate: 2023-04-28
:revdate: 2023-05-13
:page-pagination:
[abstract]
@ -10,7 +10,7 @@ To make changes in Docs page hosted on GitLab, you have a built-in web editor th
- There is no risk of breaking anything.
- This guide is for GitLab-hosted repo; https://gitlab.com/fedora/docs
- This guide is for GitLab-hosted repo.
== How to use Web IDE
@ -18,9 +18,7 @@ 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 change or update.
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.
On left of the buttons, you see the latest Fedora release. 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]
@ -38,7 +36,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 Web IDE was introduced. This guide focuses on the new Web IDE.
NOTE: This contributor guide walks through the new Web IDE, introduced GitLab 15.7 release. The guide also reflects a latest change about *how to update fork*.
=== Step 2. Launch Web IDE and fork the project
@ -62,10 +60,27 @@ 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 have a forked project before, 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.
- Go to your forked project.
- Check the status of your fork underneath Web IDE button.
If your fork shows *Up to date with the upstream repository*, go to step 3 in Web IDE.
.Fork is up to date
image::gitlab-ui/update-fork-no.png[]
If your fork is behind upstream, you will see UI text how far your fork is behind.
.Update fork
image::gitlab-ui/update-fork-yes.png[]
- Click update fork button.
- The fork will display *Up to date with the upstream repository*
- Fork button disappears after fork is updated
=== Step 3. Create a new branch
On your forked project, create a new branch and switch to it following the steps below.
@ -131,7 +146,7 @@ a|image::C-MR.png[align="center",width=940,role=black-border]
=== Step 7. Post MR review
Your request to merge changes will be reviewed by Docs team. You will expect one of the following actions.
Your request to merge changes (MR) will be reviewed by Docs team. You will expect one of the following actions.
- Reviewers ask you to revise your changes
@ -141,7 +156,7 @@ Your request to merge changes will be reviewed by Docs team. You will expect one
Whatever the case it is, MR comments facilitate collaboration between contributors and reviewers. Everyone can learn from those comments and corrections.
Once your merge request is approved, the process is complete.
Once your MR is approved, the process is complete.
|===
a|image::D-CommentsInMR.png[align="center",width=940,role=black-border]