Fedora Docs team contributor tutorial video Part 1 - unedited for preview and feedback. No sound or effects.
= GitLab Web IDE tutorial video
Note: this document is screen recording script that accompanies a video file and provides contextualized dialogue. Audio or caption not included
The Docs team is responsible for both creating documentation and enhancing Docs web site experience, and helping contributors while they create documentation. Whether it is broken link, outdated screenshots of graphical user interface, technical and grammatical error, every little contribution helps Fedora Linux users. This tutorial video caters for new and existing docs writers who are interested in Web IDE for next contributions. Docs authoring tool is not reserved to experts. Web IDE can be used for light or heavy edits, and personal projects. No need to request write access to main or developer role.
== Part 1. How to fix inactive link and navigate to Fedora Docs editing tool
Go to User Documentation on the lower right corner from the new Fedora Website - https://fedoraproject.org/start/
Click system upgrade on the left pane
Read the docs and check if the link works correctly
Example: Automatic upgrade using dnf system upgrade
Link: https://docs.fedoraproject.org/en-US/fedora/latest/system-upgrade/#quick-docs:dnf-system-upgrade.adoc
If the link does not open the page, check the URL and file name
Press the 'Edit this Page' button on top-right corner to go to GitLab
Note: To simplify the content, the video skipped GitLab authentication process.
== Part 2. How to use Web IDE
Click the blue 'Web IDE' button
Create a new fork and a branch
Create a new branch and switch to it. See status bar
To create a branch from the current branch in the Web IDE Beta:
On the status bar, in the lower-left corner, select the current branch name.From the dropdown list, select Create new branch….Enter the branch name.Press Enter.Are you sure you want to checkout "branch-sequence"? Any unsaved changes will be lost.
In editor on the right, Scroll through which line is causing the problem(In this case), check the different repository the page references toEdit the line or start writingSave your work with Commit & PushPush to current branch (you created)Press the 'Create MR' button that redirects to GitLab MR creation UIOpen merge requestAdd MR descriptions what your MR fixesYou will see the following message.
Ready to merge by members who can write to the target branch.
Your MR is successfully submitted for review. Check the progress in 48 hours.If you receive a comment, revise your MR to improve or fix anything you overlookedThanks for your contribution.
== Credit and Acknowledgements
=== Software and asset used
Fedora KDE Plasma 38 Scientific LabGitLab Free tier 15.11 ReleaseFirefox 112.0.1 Alpenglow themeOpen Broadcaster Software (OBS) Studio 29.0.2Kdenlive 22.12.3Peertube: @[email protected]Montserrat open fontsCreative Commmons Attribution-ShareAlike 4.0 International
FAS ID: hankuoffroad