envo icon indicating copy to clipboard operation
envo copied to clipboard

move internal editors/contribution documentation to mkdocs system

Open cmungall opened this issue 2 years ago • 4 comments

proposal:

move docs from the wiki to a docs/ folder in the main repo, and then publish via mkdocs

Many other ontologies do this: CL, Mondo, RO

Advantages:

  • we can make PRs and review proposed changes to docs
  • better user experience

For broader context on my proposal to harmonized contributor/editor docs across OBO: https://docs.google.com/presentation/d/1YyWYSetDML3nhNgMUmcrsw80Xx1Uf1n1dWI-A20PMa8/edit

cmungall avatar Aug 11 '22 14:08 cmungall

Fine with that - also prevents loss if wikis go down

pbuttigieg avatar Aug 11 '22 15:08 pbuttigieg

Maybe call this a medium term priority?

kaiiam avatar Aug 11 '22 18:08 kaiiam

Thanks. I don't think it's a high priority but now I have your approval I may attempt this if an opportunity presents itself

cmungall avatar Aug 11 '22 20:08 cmungall

If there's an easy way to do it without breaking all the links in the github wiki docs go for it. Otherwise it could also be an opportunity to consolidate/revise docs but that'd be a longer process. Migrating what we already have would be a great start if automatable.

kaiiam avatar Aug 12 '22 16:08 kaiiam