From 169dfd76c7cbd554053b16aca05ee3dc820c4571 Mon Sep 17 00:00:00 2001 From: hankuoffroad Date: Mon, 1 May 2023 15:22:04 +0000 Subject: [PATCH] Contribution process simplified --- .../ROOT/pages/contributing-docs/index.adoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/contributing-docs/index.adoc b/modules/ROOT/pages/contributing-docs/index.adoc index bc1e38f..63e1609 100644 --- a/modules/ROOT/pages/contributing-docs/index.adoc +++ b/modules/ROOT/pages/contributing-docs/index.adoc @@ -1,7 +1,7 @@ = Write contributions to Docs Fedora Documentation Team :revnumber: F36 and newer -:revdate: 2023-04-22 +:revdate: 2023-05-01 :page-aliases: contributing @@ -45,20 +45,20 @@ The only requirements for contributing documentation to Fedora Docs are: == The tools -=== The quick way: Edit a specific file +=== Quick way: 'Edit' button -- Suitable for minor fixes of existing pages. +- Make changes to a single file for minor fixes directly from web UI of Git forge. - Write access to upstream repo required. -- Use it as an exception, rather than a recommended option. +- Use it as an exception (without review process), rather than a recommended option. -=== The easy way: GitLab Web IDE +=== Easy way: Web IDE of Git forge +- Make changes to multiple files directly from web UI of Git forge. - No need to install anything in local computer or run Git commands in terminal. -- All of the steps are carried out in GitLab graphical user interface. -- Suitable for editing existing articles as well as new ones. +- Pull Requests for review process (Merge Requests in GitLab) - You do not need special permissions or write access to the original project. -=== The advanced way: Create a local writing environment +=== Flexible and advanced way: Create a local writing environment - Work with multiple files and repos offline at your pace using your choice of text editor and terminal. - You can build and render the pages locally to test your changes using Podman container. @@ -73,7 +73,7 @@ Many ways for various types of contribution. For example, typo fixes, adding sho This task involves minor changes. For example, typo fixes, adding short information or a link, or a correction to the text. This type is especially necessary whenever the documentation needs to be updated for a new software version. -The _File Edit tools_ are convenient for this purpose. +The _File Edit button_ are convenient for this purpose. === Extend an existing documentation domain