Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

automate subproject metadata parsing #55

Open
5 of 12 tasks
casperdcl opened this issue Sep 16, 2019 · 10 comments
Open
5 of 12 tasks

automate subproject metadata parsing #55

casperdcl opened this issue Sep 16, 2019 · 10 comments
Assignees
Milestone

Comments

@casperdcl
Copy link
Member

casperdcl commented Sep 16, 2019

  • 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)
  • support automated definition (crawl all openworm repos for more subgroups with .openworm.*)
  • cloud CI (e.g. .travis.yml)
  • auto-label pages with "last updated TIMESTAMP" based on pulled subproject config modified time

@casperdcl casperdcl self-assigned this Sep 16, 2019
@casperdcl
Copy link
Member Author

@cheelee let me know if this sounds reasonable

@casperdcl
Copy link
Member Author

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

@casperdcl casperdcl changed the title automate metadata parsing automate subproject metadata parsing Sep 16, 2019
@cheelee
Copy link

cheelee commented Sep 17, 2019

@casperdcl Hi! This looks reasonable. Thanks!

@mwatts15
Copy link
Contributor

Is just to create a blurb for each project repo?

@casperdcl
Copy link
Member Author

casperdcl commented Sep 18, 2019

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
Copy link
Member Author

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
Copy link
Member Author

I'll try to use the current http://docs.openworm.org/en/latest/projects/ plus the comment above (#55 (comment)) to come up with snippets (.openworm.yml / .openworm.md) etc to produce a new version of http://docs.openworm.org/en/latest/projects/

This was referenced Sep 25, 2019
This was referenced Oct 21, 2019
@pgleeson
Copy link
Member

pgleeson commented Apr 8, 2021

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

@casperdcl
Copy link
Member Author

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

@pgleeson
Copy link
Member

pgleeson commented Apr 8, 2021

Understood. Thanks for your continued interest in all this.

@pgleeson pgleeson modified the milestones: 2021 update 2, 2024 update 2 Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants