[BB-6531] Create Intermediate Documentation and Improve Tooling
Story
"As a new developer, I want basic documentation and tooling so that I can work with the app more readily"
Full description
There have been a handful of features implemented that are waiting on UX/UI designs to be fully 'complete' and have more final documentation. However, it's clear it will likely be a few months before these features are available in a stable form. Therefore, we need to have better intermediate documentation and tooling.
Completion criteria
-
Add a docs directory, and split the information in the ReadMe into links to documents within it. -
Remove support for crontab-style recurrences. We don't have a production use case for these. -
Use the new short-stuff JS/TS port to augment the existing admin creation views for things like inline checklist task definitions. Right now adding additional definitions to the set just duplicates the last short code in the set.Obviated by no longer having the ID be editable in the list -
Make it to where the password field on creating a new user takes a password, not a password hash. (The hashing should be done upon save) -
Find places in the admin where references to foreign keys or many-to-many entries would likely balloon quickly, and change them to raw_id fields. For instance, in the teams admin, instead of listing all users, it should have a raw_id field. Similarly, in recurrences and runs, the foreign keys for Checklists and checklist definitions should be raw_ids. - Add documentation that introduces the application, and how to set up:
-
Teams -
Checklist definitions -
Recurrences -
How to install Listaflow to a Kubernetes cluster via helm chart (cc @gabor-boros ). The goal is to make it easy for another team to deploy this. -
How to perform a release, frontend and back
-
Documentation updates & improvements criteria
- A list of specific documentation requirements, to ensure constant attention and iterative improvements to documentation, or the mention "Left to the assignee’s appreciation"
Edited by Fox Piacenti