Working with the Web based Page Editor
Fedora forge, where Fedora documentation is stored, offers the option of editing files directly in a web-based editor in the forge. This editor currently only offers basic editing functions. For example, it does not provide a preview feature. It is therefore particularly suitable for making small changes, such as correcting typos or individual sentences, quickly and easily.
|
This article is outdated and needs updating. |
Members of the Fedora Server Working Group make changes directly in the main version that is published. Therefore, there is no opportunity to discuss and agree on it beforehand. For major changes, it is advisable to insert a note that the text is waiting for a final review.
However, changes are not immediately visible to the public, but only after the pages are updated hourly.
Non-members automatically save the changes in a fork and create a notification to integrate them (merge request).
How to access an article for editing
The easy way
As an example, you may want to modify the local interactive installation guide. Open that page in your browser.
At the top you see an editor button. It opens the web page editor with that article already loaded.
The direct way
Open the server user documentation on Fedora Forge in your browser.
Follow the directory tree until you find the local installation guide at modules/ROOT → pages → installation → interactive-local.adoc. The file name does resemble the article title in a abbreviated form.
A click on the file name opens the web editor the same way as with the easy way.
How to modify an article by editing
The first thing you have to do is to log in with your Fedora account. Use the button in the top right corner. Afterwards you get some more options in the menu bar.
Among other things, there is an editor button there that opens the editor.
The Fedora Server Edition working group and Pagure follow the "Pull Request Workflow". According to this, no one is supposed to change a published page immediately, but the workflow creates a copy of the page under your name (the "fork") and when you are done, the community is informed about your proposal (the pull request, or PR for short). The community can discuss the proposal and after agreement the administrator can "pull in" the proposal. The process is also known as "merge request" (MR).
The pagure Web Editor takes care of all the details "behind the scenes". You don’t need to worry about it. Just proceed to edit the page.
More details to follow soon.
Want to help? Learn how to contribute to Fedora Docs ›