From 692316d32bd4dd19c7dc4c05fc0395e2cc52b3db Mon Sep 17 00:00:00 2001 From: hankuoffroad Date: Fri, 10 Feb 2023 16:32:29 +0000 Subject: [PATCH] Proofread in context of Pagure where QuickDocs repo is --- .../contributing-docs/contrib-quickdocs.adoc | 27 ++++++++++--------- 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc b/modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc index 31d781e..22e0e23 100644 --- a/modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc +++ b/modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc @@ -14,20 +14,21 @@ As a collection of shorter how-tos and more extensive tutorials, the articles co ==== == Types of content -Fedora Quick Docs is especially a place for 2 types of articles +Fedora Quick Docs is especially a place for two types of articles How-to:: Its characteristics are -* Intended to be useful when _working_ with Fedora -* Characterized by a _strict problem and goal orientation_ -* It is usually a relativ _short_ text, probably no longer then 60,000 characters. -* Comes usually as a _step-by-step_ instruction to resolve a small, specific problem or task, without extensive explanation. +* Intended to be useful when working with Fedora +* Characterized by a strict problem and goal orientation_ +* It is usually a relatively short text, probably no longer than 60,000 characters +* Comes usually as a step-by-step instruction to resolve a small, specific problem or task, without extensive explanation + Tutorial:: Its characteristics are -* Intended to be useful when _studying_ a software or a set thereof for a specific purpose in Fedora -* Characterized by a _learning orientation_ -* It is often a _more extensiv_ text, probably longer then 80,000 characters. -* Comes usually as a _lesson_ type of text, combining some explanations and some step-by-step instructions +* Intended to be useful when studying a software or a set thereof for a specific purpose in Fedora +* Characterized by learning orientation +* It is often a more extensive text, probably longer than 80,000 characters +* Comes usually as lesson type of text, combining some explanations and some step-by-step instructions If your post does not fit into either category, consider an article under Administration Tools or on the Home page. The best place to ask is discussion.fedoraproject.org #docs. @@ -41,14 +42,16 @@ Typical roles/tasks are * reviewer * spell checking * wording improvements +* QuickDoc organization +* Revision of the articles == How to contribute -* Generell a _merge request_ (MR) workflow -* Either local authoring environment, GitLab Web IDE, or single page editor +* General _Pull Requests_ (PR) workflow +* Either local authoring environment or page editor in Pagure user interface == What to pay attention to? -* Readability (short sentences, structured into short paragraphs. visual guidance / visual structure, no "Pixel Wüste" (pixel desert, don't know the English term for massive, unstructured and therefore just hard to read pile of text) +* Readability (short sentences, structured into short paragraphs. visual guidance / visual structure, no "Pixel Wüste" (pixel desert, don't know the English term for massive, unstructured and therefore just hard to read pile of texts)