docs

Author: gggeek

README.md

@@ -140,7 +140,9 @@ See the section 'Alternative commands to dbstack' below for examples.
 
 ### Maintenance
 
-3 scripts are provided in the top-level `bin` folder to help keeping disk space usage under control
+The `./bin/dbstack cleamup` command is provided to help keeping disk space usage under control. It can remove the
+log files produced by running the application, as well as the complete set of database data files.
+
 
 ### How does this work?
 
@@ -151,7 +153,7 @@ Docker is used to run the app:
 - each db instance runs in a dedicated container (except SQLite)
 - one container runs the web interface
 - one container runs the command-line tools which connect to the databases
-- one container runs Adminer, a separate, self-contained db administration app, also written in php
+- one container runs Adminer, a separate, self-contained db administration web app, also written in php
 
 Docker-compose is used to orchestrate the execution of the containers, ie. start, stop and connect them.
 
@@ -165,7 +167,7 @@ from the `dbconsole`.
 This design has the following advantages:
 
 - parallel execution of queries across all database instances to reduce the total execution time
-- it does not let the warts of php database-connectors influence the results of query execution
+- it does not let the warts of the php database-connectors influence the results of query execution
 - it can easily expand to run queries on multiple database types, even those not supported by php
 
 On the other hand it comes with some serious drawbacks as well, notably:

doc/TODO.md

@@ -103,7 +103,8 @@
 
 - build:
   + while setting up symfony, have the web site show up a courtesy page
-  + when there are no db data files, dbstack should wait for the db instances to be fully ready...
+  + allow dbstack to download and install docker-compose if it is not found
+  + when there are no db data files, dbstack & dbconsole should wait for the db instances to be fully ready...
     (use docker native status monitoring to achieve this?)
   + add a composer post-upgrade script that downloads automatically the latest version of adminer or at least checks it
   + run security-checker as part of composer post-install and post-upgrade?

doc/WHATSNEW.md

@@ -1,7 +1,7 @@
 Version 0.10
 ------------
 
-- Breaking change: renamed `stack.sh` to `dbstack`
+- Breaking change: renamed `stack.sh` script to `dbstack`
 
 - Breaking change: removed `cleanup-databases.sh`, `cleanup-docker-images.sh`, and `cleanup-logs.sh` - the functionality
   of these scripts has been added to `dbstack`