From 18424717f44b51f41dc72542074b35ecf9f0cfba Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 23 Dec 2017 12:56:33 +0100 Subject: [PATCH] Rewrite TODOs into Roadmap --- doc/src/09000-roadmap.md | 104 +++++++++++++++++++++++++++++++++++++ doc/src/09000-todos.md | 91 -------------------------------- doc/src/09020-changelog.md | 2 +- 3 files changed, 105 insertions(+), 92 deletions(-) create mode 100644 doc/src/09000-roadmap.md delete mode 100644 doc/src/09000-todos.md diff --git a/doc/src/09000-roadmap.md b/doc/src/09000-roadmap.md new file mode 100644 index 00000000..a60e4aec --- /dev/null +++ b/doc/src/09000-roadmap.md @@ -0,0 +1,104 @@ +# Roadmap + +This chapter contains the Roadmap to imag 1.0. This is, of course, a _really_ +long roadmap and should considered to be approximate. + +Things done will be moved to the @sec:changelog. + +## Modules + +These modules are planned right now. Each release should contain 3 new modules +maximum. + +- [ ] imag-bibliography - For handling bibliographic references when writing + scientific papers. Like Citavi, for example. +- [ ] imag-borrow - If you lend something to someone. +- [ ] imag-cuecards - Cuecards for learning things, for example vocabulary. +- [ ] imag-filter - command to read the store from stdin, filter out entries + based on a predicate specified via the CLI and write the store back todo + stdout. +- [ ] imag-image - Image referencing, categorizing, etc. +- [ ] imag-item - Creating entries for Items in the store +- [ ] imag-ledger - Ledger functionality like beancountcand others +- [ ] imag-list - Managing lists +- [ ] imag-movie - Managing movies +- [ ] imag-music - Managing music, Possibly a scrobble server. +- [ ] imag-news - A RSS Reader +- [ ] imag-project - A project planner, integrated with imag-timetrack and + imag-todo +- [ ] imag-read - Command to load the store and pipe it to stdout (usefull for + piping/ chaining commands) +- [ ] imag-receipt - Creating, categorizing, managing receipts +- [ ] imag-shoppinglists - Managing shopping lists +- [ ] imag-summary - Meta-command to call a set of imag commands (configurable + which) and displaying their outputs. +- [ ] imag-url - Extracting URLs from enties, saving URLs to the imag store +- [ ] imag-weather - Weather tooling for getting forecast and recording a + history of weather +- [ ] imag-fitness - A fitness tracker + - [ ] imag-fitness-workout - Tools for tracking workouts. + - [ ] imag-fitness-weight - Weight tracker + - [ ] imag-fitness-step-counter - Step counting tool +- [ ] imag-write - Command to read the store from stdin and write it to the + filesystem store (usefull for piping/chaining commands) + +## Other Todos + +* [ ] TUI frontend + * [ ] TUI for 'imag' + * [ ] TUI for 'imag-annotate' + * [ ] TUI for 'imag-diagnostics' + * [ ] TUI for 'imag-gps' + * [ ] TUI for 'imag-grep' + * [ ] TUI for 'imag-link' + * [ ] TUI for 'imag-mv' + * [ ] TUI for 'imag-ref' + * [ ] TUI for 'imag-store' + * [ ] TUI for 'imag-tag' + * [ ] TUI for 'imag-view' + * [ ] TUI for 'imag-bookmark' + * [ ] TUI for 'imag-contact' + * [ ] TUI for 'imag-counter' + * [ ] TUI for 'imag-diary' + * [ ] TUI for 'imag-habit' + * [ ] TUI for 'imag-mail' + * [ ] TUI for 'imag-notes' + * [ ] TUI for 'imag-timetrack' + * [ ] TUI for 'imag-todo' + * [ ] TUI for ... + +## 0.6.0 + +- [ ] imag-wiki - A wiki for personal use +- [ ] imag-init - A command to initialize a imag directory +- [ ] imag-git - wrapper to call git commands on the imag store no matter + whether the current working directory is the store or not + +## 0.7.0 + +- [ ] imag-rate - Attaching a rating to an entry +- [ ] Move away from github + - [ ] Have own issue tracking (possibly git-dit) + - [ ] Find a solution to having no travis-ci via github anymore + - [ ] Setup a viewer for the mailinglist archive +- [ ] Add maintainer scripts to repository + - [ ] To check patches for Signed-off-by lines + - [ ] To automatically craft a reply to a contributor about a missing + signed-off-by line + - [ ] To automatically craft a reply to a contributor about a patchset that + cannot be applied + - [ ] To check pull requests for GPG signatures + - [ ] To apply a patchset in a new branch + +## 0.8.0 + +* ... + +## 0.9.0 + +* ... + +## 0.10.0 + +* ... + diff --git a/doc/src/09000-todos.md b/doc/src/09000-todos.md deleted file mode 100644 index 67b22cd4..00000000 --- a/doc/src/09000-todos.md +++ /dev/null @@ -1,91 +0,0 @@ -# Todo - -This section contains long-term todos. Some kind of roadmap, of one wants to put -it that way. - -## Modules - -Modules imag should offer which are not yet started or in progress, including a -short note what each module should do. - -First the modules which have been implemented in some way (not necessarily -perfect or feature-complete): - -- [x] imag-annotate - A helper for quickly annotating entries in the store -- [x] imag-bookmark - A bookmark manager for web browsing. -- [x] imag-contact - Contact tooling based on vcard files. No sync functionality. -- [x] imag-counter - Counting things. -- [x] imag-diagnostics - Write out some diagnostics about the imag store -- [x] imag-diary - A diary, or multiple. -- [x] imag-gps - Adding GPS coordinates to entries -- [x] imag-grep - A helper to grep through the store (not entry headers) -- [x] imag-grep - A utility for greping through content -- [x] imag-link - Linking imag entries to eachother -- [x] imag-notes - Note taking -- [x] imag-ref - Refering to files outside the imag store. -- [x] imag-store - Low Level CLI Store interface -- [x] imag-tag - Tagging imag entries -- [x] imag-timetrack - Tracking time like with timewarrior -- [x] imag-todo - Tracking tasks like with taskwarrior -- [x] imag-view - Viewing imag entries - -Now the modules that are not yet started: - -- [ ] imag-bibliography - For handling bibliographic references when writing - scientific papers. Like Citavi, for example. -- [ ] imag-borrow - If you lend something to someone. -- [ ] imag-calendar - Calendar tooling based on icalendar files. No sync - functionality. -- [ ] imag-category - For categorizing imag entries. Categories must exist - before an entry can have a category. -- [ ] imag-cuecards - Cuecards for learning things, for example vocabulary. -- [ ] imag-filter - command to read the store from stdin, filter out entries - based on a predicate specified via the CLI and write the store back to stdout. -- [ ] imag-git - wrapper to call git commands on the imag store no matter - whether the current working directory is the store or not -- [ ] imag-habit - Tracking ones habits (create habits and make sure you do what - you've planned) -- [ ] imag-image - Image referencing, categorizing, etc. -- [ ] imag-item - Creating entries for Items in the store -- [ ] imag-ledger - Ledger functionality like beancountcand others -- [ ] imag-list - Managing lists -- [ ] imag-mail - Mail handling tool, a CLI-mutt like tool. -- [ ] imag-movie - Movie database handling, categorization and such things -- [ ] imag-music - Music database handling, categorization and such things. - Possibly a scrobble server. -- [ ] imag-news - A RSS Reader -- [ ] imag-project - A project planner, integrated with imag-timetrack and - imag-todo -- [ ] imag-rate - Attaching a rating to an entry -- [ ] imag-read - Command to load the store and pipe it to stdout (usefull for - piping/ chaining commands) -- [ ] imag-receipt - Creating, categorizing, managing receipts -- [ ] imag-shoppinglists - Managing shopping lists -- [ ] imag-summary - Meta-command to call a set of imag commands (configurable - which) and displaying their outputs -- [ ] imag-url - Extracting URLs from enties, saving URLs to the imag store -- [ ] imag-weather - Weather tooling for getting forecast and recording a - history of weather -- [ ] imag-weight - Weight tracker -- [ ] imag-wiki - A wiki for personal use -- [ ] imag-workout - Tools for tracking workouts. One sub-module will be - step-counter tracking -- [ ] imag-write - Command to read the store from stdin and write it to the - filesystem store (usefull for piping/chaining commands) - -## Project structure and development - -- [ ] Move away from github - - [ ] Have own issue tracking (possibly git-dit) - - [ ] Find a solution to having no travis-ci via github anymore - - - [ ] Setup a viewer for the mailinglist archive -- [ ] Add maintainer scripts to repository - - [ ] To check patches for Signed-off-by lines - - [ ] To automatically craft a reply to a contributor about a missing - signed-off-by line - - [ ] To automatically craft a reply to a contributor about a patchset that - cannot be applied - - [ ] To check pull requests for GPG signatures - - [ ] To apply a patchset in a new branch - diff --git a/doc/src/09020-changelog.md b/doc/src/09020-changelog.md index 984444f9..f14ce8f3 100644 --- a/doc/src/09020-changelog.md +++ b/doc/src/09020-changelog.md @@ -1,4 +1,4 @@ -# Changelog +# Changelog {#sec:changelog} This section contains the changelog.