openworm_docs
openworm_docs copied to clipboard
automate subproject metadata parsing
- [x] use openworm/*/master/.openworm.y(a)ml
- [ ] review current spec & possibly update
- [ ] use openworm/*/master/.openworm.md
- [ ] with optional YAML metadata block (so no
*.ymlrequired) - [ ] introduce developer guidelines on how/what to write/update
- [ ] support injection of sub-groups pages
- [ ] with optional YAML metadata block (so no
- [ ] support manual definition (top-level config file pointing to subgroup urls & collections)
- [x] support automated definition (crawl all openworm repos for more subgroups with
.openworm.*) - [x] cloud CI (e.g.
.travis.yml)- [ ] pull metadata sources to build http://docs.openworm.org/en/latest/projects/
- [x] automatically run e.g. daily
- [x] auto-label pages with "last updated TIMESTAMP" based on pulled subproject config modified time
- fixes #33
- fixes #32
@cheelee let me know if this sounds reasonable
may have to split this issue into multiple smaller ones and/or small PRs.
@casperdcl Hi! This looks reasonable. Thanks!
Is just to create a blurb for each project repo?
an up-to-date blurb (.openworm.yml) to appear on e.g. http://docs.openworm.org/en/latest/projects/ but also optionally a page (.openworm.md) to appear on e.g. http://docs.openworm.org/en/latest/Projects/sibernetic/
both of which subprojects maintain in their own repos, perhaps using their own automation processes.
from https://github.com/orgs/openworm/teams/google-season-of-documentation/discussions/2 -
http://docs.openworm.org/en/latest/projects/ has no bad links; but
- "Data Collection and Representation" is a somewhat loose collection of subgroups
- "Muscle/Neuron/Channel" is a collection of the work of 3-4 different subgroups.
- "Optimization engine" is orphaned and should be removed.
- "Education" should be added with the associated robotics and wormworx tool repos.
- "Community" needs very serious content updates, and still references deprecated chat channels like Gitter.
-- @cheelee
I'll try to use the current http://docs.openworm.org/en/latest/projects/ plus the comment above (https://github.com/openworm/openworm_docs/issues/55#issuecomment-535068045) to come up with snippets (.openworm.yml / .openworm.md) etc to produce a new version of http://docs.openworm.org/en/latest/projects/
@casperdcl This info is appearing (and seems to be updating correctly) on https://docs.openworm.org/Community/repositories/. Ok to close or more to do?
I think the unticked boxes should ideally still be addressed to unify things a bit better...
Understood. Thanks for your continued interest in all this.