Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Refactor documentation system #301

Closed
cmungall opened this issue Jul 10, 2013 · 4 comments
Closed

Refactor documentation system #301

cmungall opened this issue Jul 10, 2013 · 4 comments
Labels

Comments

@cmungall
Copy link
Member

The current doc system is described here URL: http://purl.obolibrary.org/obo/uberon/references/reference_0000000

Issues:

  • Not friendly to web-based editing of manual pages, design patterns etc
  • Editor must edit from within Protege, no native markdown support, no way to see formatted changes
  • Individual articles not versioned
  • numeric ordering by ID not necessarily the most intuitive
  • we end up re-inventing our own CMS

Suggested replacement:

  • use github wiki system
  • continue to use md as format
  • individual page per article
  • directory contents can still be slurped into owl for importation and linking within protege
  • can clone git@github.com:cmungall/uberon.wiki.git and edit md files just like a stanard git repo

Advantages:

  • multiple people can contribute by editing via github wiki
  • per-article versioning
  • can provide TOC easily
  • integrated with rest of project

Possible extensions:

  • automated job that replaces LABEL syntax with MD links to PURLs
cmungall added a commit that referenced this issue Jul 10, 2013
@cmungall
Copy link
Member Author

Completed

@cmungall
Copy link
Member Author

Although marked completed, the "about" page for the documentation describes the pre-refactored system

@cmungall
Copy link
Member Author

Note: we have not necessarily abandoned the idea of the documentation being semantic.

We should have conventions for embedding metadata in the markdown (a kind of RDFa for markdown if you will).

At the moment we have lines such as:

Status: [intermediate draft](http://purl.org/spar/pso/intermediate-draft)

There's kind of implicitly a JSON-LD-like-context entity that maps this to the property that was used originally in the owl version of the docs. Conversion back to RDF should not be hard if conventions are followed. Easy to fall into a rabbit hole here but may be useful in the future.

@cmungall
Copy link
Member Author

Original page moved here and changed status to a proposal
https://github.com/obophenotype/uberon/wiki/Documentation-metamodel

New about page here:
https://github.com/obophenotype/uberon/wiki/About-documentation

This should clarify #333

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant