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

Fork and MR process update

Browse source
This commit is contained in:
Test Lab 2023-03-16 18:30:51 +00:00 • committed by hankuoffroad
commit c1dde62cfa
1 changed files with 22 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -37,33 +37,39 @@ 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: Since GitLab 15.7, a new default Web IDE editor has been 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 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.
=== Launch Web IDE and fork the project
Click the "Open in Web IDE" button. Alternatively, press . (dot) to launch Web IDE.
Click the *Open in Web IDE* button. Alternatively, press . (dot) in keyboard to launch Web IDE.
|===
a|image::3-EditPage.png[align="center",width=940,role=black-border]
|===
Click the "Fork" button:
==== Fork a project first time
The "Fork" button appears only the first time you contribute to the repository of a given Docs page. If you are contributing to the Fedora project first time and you do not have write access for the repository you want to contribute to, you need to fork a project.
Click the *Fork* button.
The *Fork* button appears only the first time you contribute to the repository of a given Docs page. If you are contributing to the Fedora project first time and you do not have write access for the repository you want to contribute to, you need to fork a project.
A fork is a personal copy of the repository, which you create in your namespace.
If you have already "forked" that repository before (e.g., during an earlier contribution), you will be forwarded automatically to the next step without the "Fork" button.
==== 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.
|===
a|image::4-EditFork.png[align="center",width=940,role=black-border]
|===
If you have forked the repository before but your fork is already outdated, you do not have all current branches. If this is the case, GitLab will show you a blue "Create branch" button on the top left of the subsequent page after you clicked "Open in the Web IDE": if that happens, just click the "Create branch" button so that GitLab can do the rest for you. Then, proceed here as usual.
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]!
Then 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/
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/
|===
a|image::webuibeta-1.png[align="center",width=940,role=black-border]
@ -77,7 +83,9 @@ Once you've finished, click on both the branch (source control) icon and the fil
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.
|===
a|image::webuibeta-4.png[align="center",width=940,role=black-border]
@ -89,7 +97,7 @@ Enter a branch name and press Enter:
a|image::webuibeta-5.png[align="center",width=940,role=black-border]
|===
Click on "GitLab" in the bottom left-hand corner. This will bring up a dialog with the "Go to GitLab" option. Click on it:
Click on *GitLab* in the bottom left-hand corner. This will bring up a dialog with the *Go to GitLab* option. Click on it:
|===
a|image::webuibeta-6a.png[align="center",width=940,role=black-border]
@ -97,13 +105,13 @@ a|image::webuibeta-6a.png[align="center",width=940,role=black-border]
=== Merge request
Click "Create merge request" on the banner that appears (you will be directed to a <<merge-request,merge request>>):
Click *Create merge request* on the banner that appears (you will be directed to a <<merge-request,merge request>>):
|===
a|image::webuibeta-8.png[align="center",width=940,role=black-border]
|===
Edit the title and the description of the page. Next, scroll down to the blue "Create merge request" button and click it:
Edit the title and the description of the page. Next, scroll down to the blue *Create merge request* button and click it:
|===
a|image::B-EditTitleAndCreateMR.png[align="center",width=940,role=black-border]
@ -117,13 +125,13 @@ a|image::C-MR.png[align="center",width=940,role=black-border]
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.
- Reviewers ask you to revise your changes
- Approve
- Reject
- Reject within reason
Whatever the case it is, MR comments facilitate collaboration. Everyone can learn from those comments and corrections.
Whatever the case it is, MR comments facilitate collaboration between contribututors and reviewers. Everyone can learn from those comments and corrections.
Once your merge request is approved, the process is complete!