search

BeeBiome-consortium / beebiome-data-portal

A resource for scientists and the general public on bee-associated microbes/viruses and their impact on bee health
GNU General Public License v3.0
4 stars 4 forks source link

Create contributing guide for non-technical users #11

Open ropolomx opened 3 years ago

ropolomx commented 3 years ago

Create a document for non-technical members to make updates to About pages, "Wiki", etc.

ropolomx commented 3 years ago

Addressed by #14 submitted by @Juke34

Juke34 commented 3 years ago

I would say partially addressed because I do not mention anything about Wiki. ^^

ropolomx commented 3 years ago

Good point. I think since the Wiki pages of the portal (which are more like catalogue) are Markdown documents, the contributing guidelines would also apply. Thanks for suggesting those guidelines, @Juke34! Those will be a great addition.

Juke34 commented 3 years ago

I understand now, yes the wiki is not really a wiki. Well we shoud at least add a Edit on GitHub sticker on top left that point to the wiki folder. If I understand how it works we cannot see the rendering of a modification without making a proper deployment right? If it is the case I would suggest to move the doc to something like readthedocs.

ropolomx commented 3 years ago

I think those are excellent ideas! Thank you, @Juke34 .readthedocs is a very good suggestion, and it might work very well with the documentation of the codebase that @greysaruman is writing.