1
0
Fork 0
forked from docs/team-docs

Fixed issues with the Quick Doc template

This commit is contained in:
Peter Boy 2023-08-10 13:46:00 +02:00
commit 4f181c29e5
2 changed files with 23 additions and 3 deletions

View file

@ -0,0 +1,16 @@
= ARTICLE_TITLE
AUTHOR_1; AUTHOR_2; AUTHOR_3
:revnumber: Fxy
:revdate: yyyy-mm-dd
:category: CATEGORY
:tags: TAG_01 TAG_02 TAG_03 ... TAG_n
//:page-aliases: OPTIONAL
// Optional free form useful additional information as comment
[abstract]
------
Mission statement of 2-3 sentences
------

View file

@ -151,11 +151,12 @@ xref:contributing-docs/tools-vale-linter.adoc#prerequisites[How to check documen
AUTHOR_1; AUTHOR_2; AUTHOR_3
:revnumber: Fxy
:revdate: yyyy-mm-dd
:category: CATEGORY
:tags: TAG_01 TAG_02 TAG_03 ... TAG_n
//:page-aliases: OPTIONAL
// Optional free form useful additional information as comment
:category: CATEGORY
:tags: TAG_01 TAG_02 TAG_03 ... TAG_n
[abstract]
------
@ -171,7 +172,7 @@ Authors line:: We would like to list the last 3 authors who worked on the articl
+
Alternatively use __The Fedora Documentation Team__
rev_number::
revnumber::
Use the release number preceded by 'F', e.g. F37, or a range of releases, e.g. F36,F37,F38 or F33-F37. Be as specific as possible and use 'all' only in exceptional cases
revdate:: The last date someone checked the content for category:: Select only one category from below. A category is mandatory! Categories (and tags) are the only way to retrieve an atricle.
@ -179,6 +180,9 @@ revdate:: The last date someone checked the content for category:: Select only o
tags:: one or more tags from list below
abstract:: 1-3 sentences describing content and goal. Avoid any redundancy, e.g. repeating the title
You can also xref:attachment$qd-template.adoc[download the template] to make it easier.
== List of categories to choose from
You can select only __one category__!