#176 Minor content revisions, more xrefs replace URLs, drop statscache
Merged by jflory7. Opened by jflory7.
fix/lingering-typos-in-docs  into  master

Download 176.patch

This commit makes minor content revisions and corrections, moves more cross-document linking from hard-coded URLs to internal Antora anchors, and removes statscache from the CommOps toolbox, since it is likely to go away in the near future.

Actual changes to source content were kept minimal, other than a slight modernization to current times. More unique content change will come in later PRs.


For content review, @bt0dotninja @bex @bee2502 @dhanesh95 @meskarune @wesleyotugo @x3mboy could any of you take a quick look?

For an xref sanity check, @asamalik @bex @pbokoc could one of you verify how I did these, mostly for the index.adoc file?

maybe we can add the freenode-web link like a light (quick and dirty) way to use IRC and reach us

1 new commit added

  • Add call out for participating in IRC via web chat

@bt0dotninja Nice idea. I pushed a new commit that adds a call-out for Freenode's web chat.

Metadata Update from @jflory7:
- Pull-request tagged with: team - commops, type - docs

@jflory7 I've just checked the xrefs and I've found some errors, falling into the two following categories.

Also, I don't know how to send a PR to a PR, so I can't fix it for you, even when I'd like to do that! :-)

The structure of an xref link

The structure is

So instead of:

xref:council:fcaic.adoc[Fedora Community Action and Impact Coordinator]
            ^ a module reference is missing there

you would have:

xref:council::fcaic.adoc[Fedora Community Action and Impact Coordinator]
            ^^ two colons need to be here, assuming the default "ROOT" module is being used

or:

xref:council:ROOT:fcaic.adoc[Fedora Community Action and Impact Coordinator]
              ^^ the two colons can have a specific module name in between them

** Underscores in a heading reference**

Instead of:

xref:project::index.adoc#_what-is-fedora-all-about[Four Foundations]

you'd have:

xref:project::index.adoc#_what_is_fedora_all_about[Four Foundations]

I've documented how to preview the whole site in the template repo: https://pagure.io/fedora-docs/template

2 new commits added

  • Ignore produced documentation artifacts in gitignore
  • Fix xref links per feedback from @asamalik

@asamalik Thanks for the feedback! I pushed commit f001c03faeb4c3581fe0f26426067be2df10cfce which should fix all links.

I'm going to rebase and merge this PR. :clapper:

rebased onto 6c34642374bc0851fc4505cfa2441de59417d6bd

Pull-Request has been merged by jflory7

Metadata