-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Description
Adding a report to a Knowledge Repository (KR) is unnecessarily difficult. Currently, I need to:
- Fork and clone a KR
- Start a new branch and push it upstream
- Add a new directory
- Render my report to HTML and copy to the directory
- Create a report.json file
- Start a PR
We should simplify this workflow by providing a CLI interface. Here's a draft of the ideal workflow:
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
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_countsboilerplate - In the ideal case, docere would convert reports to HTML if they were simple
.mdor.ipynbfiles
- e.g.
docere submit {report_name}- Starts a PR for the given report
- e.g.
docere submit user_count
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels