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!
😀 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) <git@jwf.io>
This commit reorganizes the ROOT module index.adoc page to include a
Table of Contents and also some "frequently sought pages", like how to
create and publish a new Fedora Docs site.
This commit also reworked some of the "Adding new docs" page. I followed
the one sentence per line convention and imported the partials from the
ROOT module for things like mailing list URLs.
This commit was tested and confirmed to work locally. Should be ready to
merge but wouldn't mind a peer review.
Signed-off-by: Justin W. Flory (he/him) <git@jwf.io>
This is a first attempt at giving Fedora Documentation Writers a one-
stop location to get started writing AsciiDoc. Instead of trying to
rewrite existing documentation about AsciiDoc, I linked out to helpful
resources maintained by the `asciidoctor.org` upstream.
However, this commit does write new documentation about handy snippets
to reuse in a Fedora-specific context. I also wrote a short guide on how
to use reusable attributes, since I realize this is something I have
done in many repositories I set up but never documented.
Part of #8 to improve the new contributor experience to Fedora
Documentation with AsciiDoc and Antora.
Signed-off-by: Justin W. Flory <git@jwf.io>
This commit creates a new page for designers who may want to contribute
to the Fedora Documentation site theming and style. As @ferdnyc subtly
demonstrated for us in fedora-docs/docs-fp-o#148, we do not do a great
job of telling people where to take their bugs or new ideas for the
Fedora Docs site user interface.
This page is not great either but it is a start! My immediate use case
is this gives me a link I can point people to who might be interested in
helping with design tasks and issues.
We can iterate and improve on this as we go. Part of #8.
Signed-off-by: Justin W. Flory <git@jwf.io>
This commit adds an internal link to @bcotton's git for docs writer
page, and also adds a link to the AsciiDoc quick reference syntax. It is
reasonable to assume someone does not have prior experience with
AsciiDoc since it is an uncommon markup language. So, this link provides
a practical reference to learn the syntax. (I refer to this page almost
every time I write Fedora Docs.)
Signed-off-by: Justin W. Flory <git@jwf.io>
I was trying to find a good place to link out about how to get in touch
with the Fedora Docs team, but sadly realized we do not have clear
pointers on how to get in touch with the Docs team.
Given this index page gets a lot of visibility as *THE* landing page for
the Fedora Docs team, I think this is a lively refresh that gives a
little more life and utility to the page.
Plus I got to use amaaaaaazing Fedora Magazine header images for the top
of our docs. Isn't it pretty? 😁
Signed-off-by: Justin W. Flory <git@jwf.io>
- Prerequisites: Only FAS account is mandatory for online edits
- Contributing: Split into sections: online, offline, and pr-management
- Add Git tips box to online section
This commit will fix errors in the following files:
modules/contributing/pages/adding-new-docs.adoc
modules/contributing/pages/git.adoc
modules/contributing/pages/local-preview.adoc
