GitLab 7-step process revised

This commit is contained in:
Test Lab 2023-04-03 16:12:11 +00:00 committed by hankuoffroad
commit e596f90c41

View file

@ -1,6 +1,6 @@
= How to make casual contributions
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revdate: 2023-03-22
:revdate: 2023-04-03
:page-pagination:
[abstract]
@ -14,7 +14,7 @@ To make changes in Docs page hosted on GitLab, you have a built-in web editor th
== How to use Web IDE
=== Select a page to edit
=== Step 1. Select a page to edit
If you found something on a Docs page you want to edit, navigate to the top right and locate three buttons.
@ -40,7 +40,7 @@ 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.
=== Launch Web IDE and fork the project
=== Step 2. Launch Web IDE and fork the project
Click the *Open in Web IDE* button. Alternatively, press . (dot) in keyboard to launch Web IDE.
@ -68,7 +68,22 @@ If you do not launch Web IDE from your fork, *edit fork in Web IDE* button will
CAUTION: If you have forked the repository before, and if you have already the related branch, GitLab will not check if your forks 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 15.11 release is expected to fix the issue by April 17 2023.
=== Write, preview, edit and repeat
=== Step 3. Create a new branch
On your forked project, create a new branch and switch to it following the steps below.
- On the status bar underneath in the lower-left corner, click the current branch name (normally main).
- From the dropdown list, select Create new branch….
- Type the branch name that is specific to a task.
- Press Enter.
- Checkout to a new branch. Click Yes to the following pop-up box.
----
Are you sure you want to checkout <branch-name>? Any unsaved changes will be lost.
----
=== Step 4. Write, preview, edit and repeat
Now, make the necessary changes in Web IDE. To write with consistency, refer to xref:contributing-docs/style-guide.adoc#prerequisites[The docs style guide]
@ -76,35 +91,23 @@ Now, make the necessary changes in Web IDE. To write with consistency, refer to
a|image::webuibeta-1.png[align="center",width=940,role=black-border]
|===
=== Commit and push your changes to a branch
=== Step 5. 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, select the source control button and click the file underneath *changes* below *Commit & Push* button) to view your changes.
|===
a|image::webuibeta-2a.png[align="center",width=940,role=black-border]
|===
Type a commit message and click *Commit & Push*. Click No to commit to existing branch.
Click on *Yes Commit to a new branch*.
=== Step 6. Merge request
|===
a|image::webuibeta-4.png[align="center",width=940,role=black-border]
|===
In the lower-right corner, you will find three options - *create MR*, *Go to project*, *Continue working*.
Enter a branch name and press enter.
image::gitlab-ui/commit.png[]
|===
a|image::webuibeta-5.png[align="center",width=940,role=black-border]
|===
Click *Create MR* to create merge request. *Go to project* option is suitable when you made small commits by stage and want to squash them into one.
Click on *GitLab* in the bottom left-hand corner. This will bring up a dialog with the *Go to GitLab* option. Click on it.
*Continue working* is when you want to make smaller commits by sub tasks. If you select *Creta MR*, the UI will navigate to merge request.
|===
a|image::webuibeta-6a.png[align="center",width=940,role=black-border]
|===
=== Merge request
Click *Create merge request* on the banner and you will be directed to a <<merge-request,merge request>>)
Click *Create merge request* on the banner.
|===
a|image::webuibeta-8.png[align="center",width=940,role=black-border]
@ -116,7 +119,11 @@ Edit the title and the description of the page. Next, scroll down to the blue *C
a|image::B-EditTitleAndCreateMR.png[align="center",width=940,role=black-border]
|===
This will bring up the new merge request.
This will bring up the new merge request. If merge request is successful, you will see the following result in the lower-middle of merge request.
----
Ready to merge by members who can write to the target 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.
@ -124,13 +131,15 @@ Your branch (source branch) will be deleted when merge request is accepted. A ch
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.
- Reviewers ask you to revise your changes
- Approve
- Reject within reason
- Reject to close MR within reason
Whatever the case it is, MR comments facilitate collaboration between contributors and reviewers. Everyone can learn from those comments and corrections.