Onboarding documentation

observational-dev / oawiki

Repository for wiki.observational.space

https://wiki.observational.space/

Creative Commons Attribution Share Alike 4.0 International

2 stars 4 forks source link

Onboarding documentation #4

Closed peytondmurray closed 9 months ago

peytondmurray commented 9 months ago

We need some documentation somewhere loud and clear on how to create issues and write content. This includes

[x] Information for building the wiki locally (already done, it's in the README.md)
[x] Creating github issues; probably we want to cover a few use cases here, including a content request issue ("I have an article but I don't have time to learn about github etc, how do I add stuff to the wiki"), bug reports, feature requests ("I want to write an article but I need some special features to make it really nice, please help"), and content modification requests ("there's a factual inaccuracy in this page, please correct it")

BakerBelays commented 9 months ago

Most reasonably, a template article would probably be the best stepping stone for an introduction on shipping pages to the site independent of the developers. I'm relatively comfortable with the basic functions of markdown, but advanced formatting features are probably best displayed in said template.

Fastest way to get things rolling is probably showing the uninitiated authors how the github functions- I can imagine in a week devs will get tired of reformatting articles instead of authors themselves just shipping them in the proper way (but maybe this is a taller order than I realize and my novice understanding is showing)

random-person-001 commented 9 months ago

What are yall's thoughts on considering this closed/done for now?

peytondmurray commented 9 months ago

We can close this for now, but can there be a new issue about contribution that goes more in depth? Like the kind of content that is acceptable, discussion about proper attribution, etc might be useful for contributors.

random-person-001 commented 9 months ago

Sounds good. #30 will be the place to go for the next step I think