Skip to content

Outline CLI for working with Knowledge Repos #12

@harterrt

Description

@harterrt

Adding a report to a Knowledge Repository (KR) is unnecessarily difficult. Currently, I need to:

  1. Fork and clone a KR
  2. Start a new branch and push it upstream
  3. Add a new directory
  4. Render my report to HTML and copy to the directory
  5. Create a report.json file
  6. Start a PR

We should simplify this workflow by providing a CLI interface. Here's a draft of the ideal workflow:

  1. docere kr add mozilla/mpr
    • fork and clone an existing KR
    • KRs should be kept in a central directory (e.g. ~/.docere/)
    • Only needs to be run once for each KR
  2. docere add {--kr kr} {report_name} {kr_directory}
    • e.g. docere add --kr mpr user_counts.ipynb user_counts
    • most of these params could have defaults defined in a config file, simplifying the command to docere add user_counts.ipynb
    • should handle all the git checkout master && git pull && git checkout -b user_counts boilerplate
    • In the ideal case, docere would convert reports to HTML if they were simple .md or .ipynb files
  3. docere submit {report_name}
    • Starts a PR for the given report
    • e.g. docere submit user_count

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions