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

Minor update, included in nav.adoc to make it public

Browse source
This commit is contained in:
Peter Boy 2023-02-09 17:54:36 +01:00
commit 7bf7bd6247
2 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
modules/ROOT/nav.adoc
View file

@ -14,8 +14,9 @@
** Contributing to existing documentation
// xref:contributing-docs/contrib-existing-documentation.adoc[Contributing to existing documentation]
** xref:contributing-docs/contrib-release-notes.adoc[Contributing to Release Notes]
** xref:contributing-docs/contrib-new-documentation.adoc[Contributing a new documentation site]
** xref:contributing-docs/contrib-quickdocs.adoc[Contributing to Quick Docs]
** xref:contributing-docs/contrib-release-notes.adoc[Contributing to Release Notes]
** Contribution Tools
*** xref:contributing-docs/tools-gitlab-howto.adoc[HowTo for casual contributions (for GitLab-based pages)]

7
modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc
View file

@ -5,9 +5,8 @@ Peter Boy; Fedora Documentation Team
[abstract]
----
As a collection of shorter how-tos and more extensive tutorials, the articles cover the entire user-related area of the Fedora Project. We provide some tips and hints on contributing in this special section.
----
As a collection of shorter how-tos and more extensive tutorials, the articles cover the entire user-related area of the Fedora Project. We provide some tips and hints on contributing in this special section.
[NOTE]
====
@ -18,11 +17,13 @@ Peter Boy; Fedora Documentation Team
Fedora Quick Docs is especially a place for 2 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.
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.