#8 Contributor's guide overhaul
Closed: complete 3 years ago by jflory7. Opened 4 years ago by pbokoc.

I have some notes on how I'd like the contributor's guide to look in the future. It's obviously not set in stone but I think this would be a good start.

  • Intro, what do we do, expectations, ...
  • How to join the project
  • Finding work to do
    • Working with issues (assign to yourself, fix, sent PR, tag issue # in PR, close it once merged)
    • Small fixes without issues (just make a PR)
  • Working with git
    • Some extreme basics: fork a repo and clone your fork, push changes to it, and create a PR, don't forget to pull from upstream often
  • Contributing to existing docs (intro that describes the differences between versioned and unversioned docs)
    • How to contribute to Release Notes (those are versioned but a specific case)
    • How to contribute to versioned docs (docs tied to a specific release, e.g. F30 Install Guide)
    • How to contribute to unversioned docs (quick docs, etc. - docs that are only built as "latest" from master)
    • How to build a preview (how to build the local repo only + how to build the whole site with your local changes included)
  • Adding new docs (clone the template repo (https://pagure.io/fedora-docs/template), change configs, create repo on pagure, add it to the site config, set permissions (add group fedora-docs as Admin))
  • Publishing docs
  • Antora internals
  • Translations (not available right now but we'll need that in the future)
  • Style Guide
    • Writing tips (simple sentences, no passive voice, that kinda stuff)
    • ASCIIDoc style guidelines:
      • one sentence per line
      • xrefs, includes
      • outside links
      • images, figures
      • imagesdir, partialsdir
      • modules, topics
      • admonitions
      • :experimental:, attributes
      • code blocks, commands with attribute replacement
      • titles (use =, one per page, multiple ==, ===; leveloffset when including)
      • lists (numberedlists always start with 1. for each point; can start with an offset, writing multiple paragraph list items...)
      • tables
      • license, readme (mention published URL in README)

There are probably several smaller issues within this bigger one. Splitting them up into smaller tickets, where we could label them as good first issue, might bring some community traction to helping out with this.

Metadata Update from @jflory7:
- Issue priority set to: needs review
- Issue tagged with: help wanted, needs feedback, type - existing docs

3 years ago

I wrote #18 as a first step to this issue. I decided to go ahead and just write it because I think it helps to have a more experienced writer take on this ticket.

https://pagure.io/fedora-docs/documentation-contributors-guide/pull-request/18

#19 is a build on @ferdnyc's experience of opening a ticket about the Fedora Docs site theme in the wrong repository. So, I decided to document it with the Fedora Docs team contributor docs, so people can hopefully have a better shot at finding it.

https://pagure.io/fedora-docs/documentation-contributors-guide/pull-request/19

So, we have a new AsciiDoc module in our docs site. Hurrah!

https://docs.fedoraproject.org/en-US/fedora-docs/asciidoc-fedora/

I think the last major thing we need here is a guide on how to set up a new Fedora Docs site project and get it published. I don't think we have this documented anywhere, and the Fedora Design and Marketing Teams have asked for this information before.

I welcome someone else who is interested in working on this! However, I will try to make a dent on this one final topic before I suggest we close this issue as complete, and then open smaller issues for better-scoped tasks so we can make iterative progress.

So, we have a new AsciiDoc module in our docs site. Hurrah!

https://docs.fedoraproject.org/en-US/fedora-docs/asciidoc-fedora/

I think the last major thing we need here is a guide on how to set up a new Fedora Docs site project and get it published. I don't think we have this documented anywhere, and the Fedora Design and Marketing Teams have asked for this information before.

I welcome someone else who is interested in working on this! However, I will try to make a dent on this one final topic before I suggest we close this issue as complete, and then open smaller issues for better-scoped tasks so we can make iterative progress.

Thanks for the pointer @mattdm! That inspired PR #23.

Given PR #23 and #24, I would be OK to close this issue as "first implementation complete" or fixed. I think recent PRs #16, #17, #18, #19, #23, and #24 are sufficient to call this "done".

Unless there are objections, I will wait until PRs #23 and #24 are merged, and then I will close this issue.

Metadata Update from @jflory7:
- Issue assigned to jflory7

3 years ago

Metadata Update from @jflory7:
- Issue untagged with: help wanted, needs feedback
- Issue priority set to: waiting on assignee (was: needs review)

3 years ago

OK! #23 and #24 were merged. As promised, I am closing this issue as complete. :tada:

Metadata Update from @jflory7:
- Issue close_status updated to: complete
- Issue status updated to: Closed (was: Open)

3 years ago

Login to comment on this ticket.

Metadata