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

Web IDE guide style enhancement

Browse source
This commit is contained in:
Test Lab 2023-03-16 21:57:21 +00:00
commit 2b16ca98b7
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -29,7 +29,7 @@ a|image::1CUT-changeIdentified.png[align="center",role=black-border]
a|image::1A-changeIdentified.png[align="center",width=940,role=black-border]
|===
Now log in to your GitLab account or create one if you do not have one yet (see the image below). Alternatively, you can also use the Fedora Account System (FAS) to log into GitLab, but you have to do this in advance before clicking the "edit the page" button with the following link: https://gitlab.com/groups/fedora/-/saml/sso[https://gitlab.com/groups/fedora/-/saml/sso]
Now log in to your GitLab account or create one if you do not have one yet (see the image below). Alternatively, you can also use the Fedora Account System (FAS) to log into GitLab, but you have to do this in advance before clicking the *edit the page* button with the following link; https://gitlab.com/groups/fedora/-/saml/sso[https://gitlab.com/groups/fedora/-/saml/sso]
If you have already a GitLab account and want to link it to your Fedora account, log into your existing GitLab account before you use the above FAS link.
@ -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 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>>.
=== Launch Web IDE and fork the project
@ -65,11 +65,11 @@ If you have a forked repository (e.g., during an earlier contribution), you will
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.
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.
=== 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/
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]
@ -91,13 +91,13 @@ Your branch (source branch) will be deleted when merge request is accepted. A ch
a|image::webuibeta-4.png[align="center",width=940,role=black-border]
|===
Enter a branch name and press Enter:
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]
@ -105,19 +105,19 @@ 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 and 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]
|===
This will bring up the new merge request:
This will bring up the new merge request.
|===
a|image::C-MR.png[align="center",width=940,role=black-border]