Hiya folks,
As we get closer to drawing a lot more eyes on our guidebook, now is a
great opportunity to go back and read some or all of the content with
refreshed eyes.
https://www.theopensourceway.org/the_open_source_way-guidebook-2.0.html
https://www.theopensourceway.org/the_open_source_way-guidebook-2.0.pdf
Following are ideas on what you can do with your comments or fixes:
In addition to reading the entirety for the sense of cohesion and
narrative, some things you might look out for:
* Grammatical anything.
* Glitches, messed up markup, etc.
* Whatever else catches your eye.
What to do if you find something to fix or comment on?
1. You can check the common bugs lists, this is where most easy typos
go:
https://github.com/theopensourceway/guidebook/issues/194
2. You can choose to find the .adoc file and do fixes to result in a
pull request.
3. If you want to write up a list of comments and reference points (page
& para on PDF/link & para for HTML), you can put those in a single
GitHub issue, or an email, or a stand-alone document.
4. If Google Doc is your tool at this point or for this task, you can
pull in the doc to a Google Doc then share that with us for commenting
back on and make it public read-only, that would be great, too.
For the last two methods (3 & 4), once we are finished discussing any
proposed changes in an issue/doc/thread, we could use help from anyone
with experience or wanting to learn about editing Asciidoc directly and
using GitHub to make the pull request. You would go through the edits
and comments, make them in the associated files, then do a pull request
for the edits. I will train and hand-hold anyone interested in this.
Caveats
=======
* The PDF has some known issues; we'll try to get them all on the common
bug reports (below).
* We're shuffling in and around some content that has been coming in
since the 2.0 release; the idea is to roll in these additions and
changes for the debut (thus it'll really be 2.0.1 or so). I'll work to
keep that clean, and offer chances for reviews of the new content.
Best regards,
- Karsten
--
Karsten Wade [he/him/his]| Senior Community Architect | @quaid
Red Hat Open Source Program Office (OSPO) : @redhatopen
https://community.redhat.com |
https://next.redhat.com |
https://osci.io
https://theopensourceway.org |
https://github.com/theopensourceway/guide