openworm / openworm/openworm_docs

automate subproject metadata parsing

Open
#55 10 comments 0 reactions 3 assignees View on GitHub

@balicea is already working on this.

Since Sep 16, 2019.

Dominant language
Python
Stars
45
Forks
26
PR merge metrics
No merged PRs in 30d

Description

  • 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

  • fixes #33
  • fixes #32

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.