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

Style improvement updated - brevity, acronyms and brief desctriptions to button/actions

Browse source
This commit is contained in:
hank L 2023-02-20 22:13:42 +00:00
commit cd3aa338f3
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

@ -8,15 +8,15 @@ Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
-> *There is no risk of breaking anything ... and all editing will be done in a GUI within your browser!*
-> *This HowTo is for GitLab-based pages only. If you were forwarded here by a link on any docs.fedoraproject.org page, you can be sure that you are in the right place!*
-> *This HowTo is for GitLab-based pages only. If you were forwarded here by a link on any docs.fedoraproject.org page, you are in the right place!*
=== Select a page to edit
If you have found something on a Docs page which you want to add, remove, change, or update, you will see three buttons on the top right
which can be used to directly put forward your suggestion without knowledge of git or the structures with which the Docs pages are
organized (repository structures). The buttons will automatically forward you correspondingly.
organized (repository structures). The buttons will forward you correspondingly.
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. The left button forwards to the version history of the opened Docs page and is *not* relevant for you. The middle button forwards to "edit the page" that is currently opened, which is what you have to click to put forward your suggested change/update. The right button forwards to "report an issue" if you only want to make us aware of some need to change/update without making this yourself. Click the middle ("edit the page") button to go ahead with putting forward your suggestions:
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. 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/update. The right button "report an issue" is when you report any change/update required. Click the middle ("edit the page") button to make suggestions:
|===
a|image::1CUT-changeIdentified.png[align="center",role=black-border]
@ -26,7 +26,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 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]
NOTE: If you have already a GitLab account and if you want to link it to your FAS account, you have to log into your existing GitLab account **before** you use the above FAS link!
@ -38,13 +38,13 @@ NOTE: Since GitLab 15.7, a new default Web IDE editor has been introduced, where
[[web-ide-editor]]
=== Web IDE editor
Click the button "Open in Web IDE":
Click the "Open in Web IDE" button:
|===
a|image::3-EditPage.png[align="center",width=940,role=black-border]
|===
Click the button "Fork" that appears:
Click the "Fork" button:
NOTE: The "Fork" button appears only the first time you contribute to the repository of a given Docs page. 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.
@ -52,15 +52,15 @@ NOTE: The "Fork" button appears only the first time you contribute to the reposi
a|image::4-EditFork.png[align="center",width=940,role=black-border]
|===
NOTE: If you have forked the repository before but your fork is already outdated, it can happen that you have not all current branches. If this is the case, GitLab will automatically 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.
NOTE: If you have forked the repository before but your fork is already outdated, it can happen that you have not 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.
Then make the necessary changes to the page in the Web IDE and ...
Then make the necessary changes to the page.
|===
a|image::webuibeta-1.png[align="center",width=940,role=black-border]
|===
\... once you've finished, click on both the branch icon and the file to view your changes. Enter a commit message and click "Commit & Push":
\... once you've finished, click on both the branch (source contrrol) 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]