Prep "guide creation" tasks for upcoming events - Githubissues

edgi-govdata-archiving / overview

🎈 Start here for current projects, how to get involved, and joining community calls, a resource for new and veteran members

GNU General Public License v3.0

118 stars 20 forks source link

Prep "guide creation" tasks for upcoming events #44

Closed dcwalk closed 7 years ago

dcwalk commented 7 years ago

Repo has been set up: https://github.com/edgi-govdata-archiving/guides

Notes from NYC Next Steps group...

Guide for Writing Guides

How to call out the need for a guide?
- create a GH issue in a "guides" repo?
How to let people know you're working on it
- claim the GH issue
Where to put the guide
- EDGI Github Repo (setup for gh pages)
- contribution guidelines (ie. how to make it jekyll-ready)
How to write it
- Markdown files
- Option: hackmd.io if collaboratively editing
- (ideally) template for writing new guides (headings, etc.)

Concerns:

Github markdown files are intimidating for everyday readers, but contributing via github is a tolerable level of expectation to place on people contributing to a guide
The resulting guides need to be not-intimidating.

dcwalk commented 7 years ago

This is almost resolved here: https://github.com/edgi-govdata-archiving/guides/pull/9 and https://github.com/edgi-govdata-archiving/guides/pull/10

dcwalk commented 7 years ago

Need to review and clean up guides: https://github.com/edgi-govdata-archiving/guides/issues?q=is%3Aissue+is%3Aopen+label%3Aguide

and I have a proposal for doing so here: https://github.com/edgi-govdata-archiving/guides/issues/11

dcwalk commented 7 years ago

This has been done! :))