#132 Write a "How to" write docs in the CommBlog
Closed: Stale 2 years ago Opened 3 years ago by x3mboy.

The idea is to write an article explaining how to write docs in the new docs.fp.o

The points we should cover are:
- Clonning the right pagure repo
- asciibinder
- Creating your local copy
- Creating PRs


Metadata Update from @x3mboy:
- Issue untagged with: Community Blog

3 years ago

Metadata Update from @jflory7:
- Issue priority set to: minor (3-4 weeks) (was: no deadline)
- Issue set to the milestone: Fedora 28 (to May 2018)
- Issue tagged with: outreach

3 years ago

I support this article and would like to make sure it can also be used for non-project members. Let's hold on finishing it until after the Docs FAD to make sure the workflow is valid. Having said that, having a draft that can be tested at the Docs FAD would be AWESOME!

Metadata Update from @jflory7:
- Issue untagged with: easyfix, help wanted
- Issue assigned to jflory7
- Issue priority set to: normal (1-2 weeks) (was: minor (3-4 weeks))
- Issue tagged with: FAD

3 years ago

I am attending the 2018 Documentation FAD at the end of this month and plan to bring this issue as something to work on with the team there. Updates to come in about two weeks.

Metadata Update from @jflory7:
- Assignee reset
- Issue untagged with: FAD
- Issue priority set to: no deadline (was: normal (1-2 weeks))
- Issue set to the milestone: Future releases (was: Fedora 28 (to May 2018))

3 years ago

Raising my hand to help out with this if the unassigned status still holds true

@roca Yes, it is unassigned and still helpful! Would you want to cover…

  1. Intro to AsciiDoc
  2. Example workflow (e.g. committing to fedora-commops repo with a pull request)
  3. How to request a docs repo

@bex (or maybe @jsmith working on Docs style guide), have opinions on the above as a "how to" for Docs in Fedora?

Metadata Update from @jflory7:
- Issue tagged with: good first issue, help wanted, meeting

3 years ago

Metadata Update from @jflory7:
- Issue untagged with: meeting

3 years ago

@roca Yes, it is unassigned and still helpful! Would you want to cover…

Intro to AsciiDoc
Example workflow (e.g. committing to fedora-commops repo with a pull request)

I think these together represent a good start. We can reference the style guide https://pagure.io/fedora-docs/documentation-guide - but it needs a lot of love still.

How to request a docs repo

I am not sure we should cover this yet as the process is about to change with antora

I noticed @rkratky submitted a proposal for a docs hackathon at Flock this year. I am adding the Flock tag to this issue. It would be great if some of our attending members participated at that workshop (if accepted) to make this article happen.

I am hoping by Flock, the previous blocking issues with Antora will be resolved. :grin:


cc: @bex @asamalik

Metadata Update from @jflory7:
- Issue set to the milestone: Fedora 29 (to Oct. 2018) (was: Future releases)
- Issue tagged with: Flock

2 years ago

My goal is to get the Antora site out before Flock.

@asamalik @ankursinha Thanks for the update.

Since this ticket is half a year old and I think there are ongoing efforts to create these resources, I am not sure if a CommBlog article makes the most sense. I think the Docs Team is planning on writing the docs ( :wink: ) on how to write the docs.

So I would prefer to close this ticket and let the Docs Team build a static, permanent reference, since I think that effort has more value than a blog post. I am going to close this ticket for now. If you feel otherwise, we can always revisit.

Metadata Update from @jflory7:
- Issue untagged with: Flock, help wanted
- Issue close_status updated to: Stale
- Issue status updated to: Closed (was: Open)

2 years ago

Login to comment on this ticket.

Metadata