diff --git a/README.org b/README.org index 6e627831..da5732b0 100644 --- a/README.org +++ b/README.org @@ -113,14 +113,13 @@ npm run labgen -- #+END_SRC -* Updates -** Reporting +* Reporting The timestamp, verion number and status (success or failure) of the run is updated to a google sheet. -** Release management of Lab Sources +* Release management of Lab Sources After a lab (including all its experiments) is deployed, a new tag is created for the lab using the master branch. The tag number @@ -131,20 +130,20 @@ The lab descriptor is updated with the current release number. -** Automated JSON Validation +* Automated JSON Validation The lab descriptor is validated using a [[file:labDescSchema.json][schema]]. If anything is invalid in the lab descriptor, the error is displayed and process aborts. -** Deployment Process +* Deployment Process 1. Stage all experiments 2. Stage Lab 3. Deploy Experiments 4. Deploy Lab -*** Staging +** Staging - /var/www/html/ - / @@ -157,22 +156,12 @@ If anything fails, you need to start the process again. -** TODO - - [-] move release type to pre run option. - - [-] log to file - - [X] remove lab name from path to experiment - - experiment is unit of development - - Current url pattern: https://de-iitr.vlabs.ac.in/digital-electronics-iitr/exp/truth-table-gates/ - - New url pattern: https://de-iitr.vlabs.ac.in/exp/truth-table-gates/ - - [X] +symlink for compatibility+ - - [X] test on a lab that is not linked - - KT to Balamma - - [-] session 1 scheduled on <2020-08-31 Mon>. Find the [[file:KT.org][minutes]] - here. +* DOCS +** Lab Descriptor -* DOCS +[[lab-descriptor.org]] ** Experiment build Process @@ -182,4 +171,24 @@ [[docs/analytics.org]] +* TODO + +- DOCS: + + Lab Build Process + + Lab descriptor - DONE + + templates - TODO + + staging and deployment process - IN PROGRESS + + + Experiment build process + - experiment descriptor - DONE + - experiment model - DONE + + + Analytics - IN PROGRESS + + + script usage - TODO + + + quiz - TODO + + + exp process integration and testing - IN PROGRESS + + descriptor validation - TODO