| |
@@ -1,21 +1,13 @@
|
| |
= Prerequisites
|
| |
|
| |
- The only requirement for contributing documentation updates to Fedora Docs is:
|
| |
+ The only requirements for contributing documentation updates to Fedora Docs are:
|
| |
|
| |
- * A link:++https://admin.fedoraproject.org/accounts/++[*Fedora Account System*] (*FAS*) account.
|
| |
+ * link:++https://admin.fedoraproject.org/accounts/++[*Fedora Account System*] (*FAS*) account.
|
| |
+ * Must have signed https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] from FAS (see https://admin.fedoraproject.org/accounts/group/view/cla_done[here])
|
| |
+ * Basic knowledge of *AsciiDoc* markup language (see xref:asciidoc-fedora:markup.adoc[AsciiDoc for Fedora])
|
| |
|
| |
For larger updates or to contribute all-new documentation, you may also need:
|
| |
|
| |
- * A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, etc., preferably with ASCIIDoc syntax highlighting.
|
| |
+ * A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, [application]`VSCode`, etc., preferably with AsciiDoc syntax highlighting.
|
| |
* [application]`git` (see xref::git.adoc[Git for docs writers])
|
| |
* [application]`Docker` or Podman for building and previewing your changes locally.
|
| |
- * Knowledge of *AsciiDoc* markup language (see https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax Quick Reference])
|
| |
-
|
| |
- +
|
| |
- [NOTE]
|
| |
- ====
|
| |
- An *ASCIIDoc* markup guide specific to Fedora Docs is planned, but not yet ready.
|
| |
- Until then, the link:++https://asciidoctor.org/docs/asciidoc-writers-guide/++[ASCIIDoc Writer's Guide] may be a helpful resource.
|
| |
- ====
|
| |
-
|
| |
- //See xref:markup.adoc[ASCIIDoc Markup].
|
| |
I noticed the
prerequisites.adoc
page mentions that an AsciiDoc guidewill be published soon and to check back later. Well, it is done now!
:grinning: So, this commit drops that note and adds the right
xref
sosomeone can go find the AsciiDoc for Fedora module.