From 985920845c8373a52e3700ef28a8f63420ecdfa3 Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Oct 07 2020 20:42:59 +0000 Subject: prerequisites: Drop note about AsciiDoc ref, add xref to asciidoc-fedora I noticed the `prerequisites.adoc` page mentions that an AsciiDoc guide will 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` so someone can go find the AsciiDoc for Fedora module. Signed-off-by: Justin W. Flory (he/him) --- diff --git a/modules/asciidoc-fedora/pages/markup.adoc b/modules/asciidoc-fedora/pages/markup.adoc index 234c3aa..8d6df6d 100644 --- a/modules/asciidoc-fedora/pages/markup.adoc +++ b/modules/asciidoc-fedora/pages/markup.adoc @@ -57,7 +57,7 @@ Multiple modules bundled in the same repository is not currently a common scenar .Example 1 [source,adoc] ---- -xref:module::page-name.adoc +xref:module:page-name.adoc ---- .Example 2 diff --git a/modules/contributing/pages/prerequisites.adoc b/modules/contributing/pages/prerequisites.adoc index d24d6bc..ba98b87 100644 --- a/modules/contributing/pages/prerequisites.adoc +++ b/modules/contributing/pages/prerequisites.adoc @@ -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].