Merge pull request #108 from openSUSE/fix_doc

Several documentation-related fixes

Gemfile

@@ -69,7 +69,7 @@ gem 'rspec-rails', group: [:development, :test]
 # Moved out of the development group to avoid an error in every rake execution
 # caused by lib/tasks/doc.rake (at least until we figure out a cleaner
 # solution)
-gem 'yard', '0.8.7.4'
+gem 'yard', '~> 0.9.0'
 group :development do
   gem 'ruby-graphviz'
   gem 'state_machines-yard'

Gemfile.lock

@@ -199,7 +199,7 @@ GEM
     mimemagic (0.3.3)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
+    minitest (5.13.0)
     multi_json (1.14.1)
     nio4r (2.5.2)
     nokogiri (1.10.4)
@@ -295,7 +295,7 @@ GEM
     ruby-graphviz (1.2.4)
     ruby-progressbar (1.10.1)
     ruby-rc4 (0.1.5)
-    ruby_parser (3.14.0)
+    ruby_parser (3.14.1)
       sexp_processor (~> 4.9)
     rubyzip (2.0.0)
     sass (3.2.19)
@@ -352,7 +352,7 @@ GEM
     thor (0.20.3)
     thread_safe (0.3.6)
     tilt (1.4.1)
-    tins (1.21.1)
+    tins (1.22.0)
     ttfunk (1.0.3)
     turbolinks (5.2.1)
       turbolinks-source (~> 5.2)
@@ -376,7 +376,7 @@ GEM
       sprockets-rails (>= 2.0, < 4.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    yard (0.8.7.4)
+    yard (0.9.20)
     yard-activerecord (0.0.16)
       yard (>= 0.8.3)
 
@@ -436,7 +436,7 @@ DEPENDENCIES
   twitter-bootstrap-rails
   uglifier (>= 1.3.0)
   web-console (~> 2.0)
-  yard (= 0.8.7.4)
+  yard (~> 0.9.0)
   yard-activerecord
 
 BUNDLED WITH

doc/DOCKER.md

@@ -17,19 +17,25 @@ straighforward.
 
         cp docker/database.postgresql.yml config/database.yml
 
-3. Build the image:
+4. Build the image:
 
         docker-compose build
 
-4. Now you should be able to set up the database:
+5. Now you should be able to set up the database:
 
         docker-compose run --rm web rake db:setup
 
-5. (Optional) Run the testsuite to find out whether the application works.
+   When using the mysql container, this fifth step may require that you have
+   started the database container some seconds in advance, since the official
+   mysql and mariadb containers need some time to initialize the system.
+
+        docker-compose up --detach db
+
+6. (Optional) Run the testsuite to find out whether the application works.
 
         docker-compose run --rm web xvfb-run -a rake spec
 
-6. And, now, you can start the application:
+7. And, now, you can start the application:
 
         docker-compose up