openworm_docs icon indicating copy to clipboard operation
openworm_docs copied to clipboard

automate subproject metadata parsing

Open casperdcl opened this issue 6 years ago • 10 comments

  • [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 *.yml required)
    • [ ] introduce developer guidelines on how/what to write/update
    • [ ] support injection of sub-groups pages
  • [ ] 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

casperdcl avatar Sep 16 '19 17:09 casperdcl

@cheelee let me know if this sounds reasonable

casperdcl avatar Sep 16 '19 17:09 casperdcl

may have to split this issue into multiple smaller ones and/or small PRs.

casperdcl avatar Sep 16 '19 17:09 casperdcl

@casperdcl Hi! This looks reasonable. Thanks!

cheelee avatar Sep 17 '19 01:09 cheelee

Is just to create a blurb for each project repo?

mwatts15 avatar Sep 18 '19 11:09 mwatts15

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.

casperdcl avatar Sep 18 '19 11:09 casperdcl

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

  1. "Data Collection and Representation" is a somewhat loose collection of subgroups
  2. "Muscle/Neuron/Channel" is a collection of the work of 3-4 different subgroups.
  3. "Optimization engine" is orphaned and should be removed.
  4. "Education" should be added with the associated robotics and wormworx tool repos.
  5. "Community" needs very serious content updates, and still references deprecated chat channels like Gitter.

-- @cheelee

casperdcl avatar Sep 25 '19 15:09 casperdcl

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 avatar Sep 25 '19 15:09 casperdcl

@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?

pgleeson avatar Apr 08 '21 15:04 pgleeson

I think the unticked boxes should ideally still be addressed to unify things a bit better...

casperdcl avatar Apr 08 '21 15:04 casperdcl

Understood. Thanks for your continued interest in all this.

pgleeson avatar Apr 08 '21 16:04 pgleeson