All:
Now is when we need some other pairs of eyes to review and edit the
content we've been working on.
Below is a list of shorter and longer reviews to do, where to find the
source, and the straightforward way if you edit in GitHub. If you are
going to copy out and edit in e.g. Google Doc, just let us know in this
thread with the link (and share Edit permissions to myself so I can get
the changes).
These chapters/intros may need a small bit of development edit still,
but are largely ready for full copy edits.
short-er
========
Section intros -- a few paragraphs and description of what is in the
chapters in the particular section.
"Getting Started":
https://github.com/theopensourceway/guidebook/blob/master/getting_started...
"Attracting Users"
https://github.com/theopensourceway/guidebook/blob/master/attracting_user...
"Guiding Participants"
https://github.com/theopensourceway/guidebook/blob/master/guiding_partici...
"Growing Contributors"
https://github.com/theopensourceway/guidebook/blob/master/growing_contrib...
"Measuring Success"
https://github.com/theopensourceway/guidebook/blob/master/measuring_succe...
long-er
=======
"Defining Healthy Communities"
https://github.com/theopensourceway/guidebook/blob/master/defining_health...
"Onboarding"
https://github.com/theopensourceway/guidebook/blob/master/onboarding.adoc
"Creating a Culture of Mentorship"
https://github.com/theopensourceway/guidebook/blob/master/creating_a_cult...
how to edit
===========
1. Look at the file in GitHub, links above.
2. On the file page, the source is rendered by GH; in the top-right
corner of the render pane is an edit "pencil".
3. You can now edit the document directly in the browser window.
4. If you want to leave a comment, add it on a new line with your
initials, like so:
KW: A comment from me!
5. You can check your changes using the "Preview changes" tab at the top
of the render space.
6. When you are done, fill out the "Commit changes" section under the
source editor.
7. Put a short description in the first field of what you did, e.g.
"Copy and style edit of chapter"
8. Put in any additional context, notes, or documentation in the
extended description field.
9. Select "Create a new branch for this commit and start a pull
request." Fill out the branch name with this or a similar format:
"username-chap-name-review-1"
10. Click "Propose Changes:".
11. This takes you to the "Open a pull request page". Fill it out thus:
- Add more comments, if needed.
- Add reviewers, if you want to call out a particular reviewer or editor.
12. Click "Create pull request".
13. Come back to this mailing list and let us know you made a pull
request for which file. We'll go look at it right away.
Questions?
--
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