Merge pull request #692 from vania-pooh/master

Reorganized documentation (fixes #690)

docs/browser-images.adoc

@@ -4,7 +4,6 @@ We maintain a set of prebuilt Docker container images for different browsers inc
 * https://hub.docker.com/r/selenoid/firefox/[Firefox]
 * https://hub.docker.com/r/selenoid/chrome/[Google Chrome]
 * https://hub.docker.com/r/selenoid/opera/[Opera]
-* https://hub.docker.com/r/selenoid/phantomjs/[PhantomJS]
 
 All these images are free to use. See image tags for a list of supported versions. Build files are stored in http://github.com/aerokube/selenoid-images[selenoid-images] repository.
 Feel free to create issues or request images for new versions.

docs/cli-flags.adoc

@@ -19,12 +19,14 @@ The following flags are supported by `selenoid` command:
     Disable wait queue
 -enable-file-upload
     File upload support
+-graceful-period duration
+    graceful shutdown period in time.Duration format, e.g. 300s or 500ms (default 5m0s)
 -limit int
     Simultaneous container runs (default 5)
 -listen string
     Network address to accept connections (default ":4444")
 -log-conf string
-    Container logging configuration file (default "config/container-logs.json")
+    Container logging configuration file
 -log-output-dir string
     Directory to save session log to
 -max-timeout duration
@@ -67,3 +69,30 @@ When using Selenoid inside Docker container these flags are passed like the foll
     -conf /etc/selenoid/browsers.json -limit 10 -video-output-dir /opt/selenoid/video/
 ----
 
+=== S3 CLI Flags
+The following flags are supported by `selenoid` command when compiled with S3 support:
+
+```
+-s3-access-key string
+    S3 access key
+-s3-bucket-name string
+    S3 bucket name
+-s3-endpoint string
+    S3 endpoint URL
+-s3-exclude-files string
+    Pattern used to match and exclude files
+-s3-force-path-style
+    Force path-style addressing for file upload
+-s3-include-files string
+    Pattern used to match and include files    
+-s3-keep-files
+    Do not remove uploaded files
+-s3-key-pattern string
+    S3 bucket name (default "$fileName")
+-s3-reduced-redundancy
+    Use reduced redundancy storage class
+-s3-region string
+    S3 region
+-s3-secret-key string
+    S3 secret key
+```

docs/file-upload.adoc

@@ -1,4 +1,4 @@
-== File Upload
+== Uploading Files To Browser
 
 Some tests require to upload files. This feature works out of the box in the majority of Selenium clients. A typical Java code snippet look like the following:
 

docs/index.adoc

@@ -21,30 +21,32 @@ include::faq.adoc[leveloffset=+1]
 include::windows.adoc[leveloffset=+1]
 include::browser-images.adoc[leveloffset=+1]
 
+== Main Features
+include::video.adoc[leveloffset=+1]
+include::logs.adoc[leveloffset=+1]
+include::file-upload.adoc[leveloffset=+1]
+include::file-download.adoc[leveloffset=+1]
+include::clipboard.adoc[leveloffset=+1]
+include::devtools.adoc[leveloffset=+1]
+include::special-capabilities.adoc[leveloffset=+1]
+
+== Advanced Features
+include::usage-statistics.adoc[leveloffset=+1]
+include::s3.adoc[leveloffset=+1]
+include::metadata.adoc[leveloffset=+1]
+include::selenoid-without-docker.adoc[leveloffset=+1]
+
 == Configuration
 include::docker-settings.adoc[leveloffset=+1]
 include::browsers-configuration-file.adoc[leveloffset=+1]
 include::logging-configuration-file.adoc[leveloffset=+1]
 include::reloading-configuration.adoc[leveloffset=+1]
 include::updating-browsers.adoc[leveloffset=+1]
 include::timezone.adoc[leveloffset=+1]
-include::video.adoc[leveloffset=+1]
-include::logs.adoc[leveloffset=+1]
 include::docker-compose.adoc[leveloffset=+1]
 include::log-files.adoc[leveloffset=+1]
 include::cli-flags.adoc[leveloffset=+1]
 
-== Advanced Features
-include::special-capabilities.adoc[leveloffset=+1]
-include::selenoid-without-docker.adoc[leveloffset=+1]
-include::usage-statistics.adoc[leveloffset=+1]
-include::file-upload.adoc[leveloffset=+1]
-include::file-download.adoc[leveloffset=+1]
-include::clipboard.adoc[leveloffset=+1]
-include::devtools.adoc[leveloffset=+1]
-include::s3.adoc[leveloffset=+1]
-include::metadata.adoc[leveloffset=+1]
-
 include::contributing.adoc[]
 
 [appendix]

docs/logs.adoc

@@ -1,5 +1,10 @@
 == Saving Session Logs
 
+[NOTE]
+====
+An additional `enableLog` capability should be added to tests. See <<Special Capabilities>> section for more details.
+====
+
 Selenoid can save log files for every running session to a separate file. By default log files are saved as `<session-id>.log` but you can alter file name via `logName` capability.
 
 To enable this feature you only need to add `-log-output-dir </path/to/some/dir>` flag to Selenoid:

docs/s3.adoc

@@ -35,32 +35,4 @@ By default uploaded file name is preserved, i.e. S3 path is `/<session-id>.log`
 
 For example, when launching Selenoid with `-s3-key-pattern $browserName/$sessionId/log.txt` files will be accessible as `firefox/0ee0b48b-e29b-6749-b4f1-2277b8f8d6c5/log.txt`. You can also override key pattern for every session with `s3KeyPattern` capability.
 
-Sometimes you may want to upload only video files or files matching some complicated pattern or to not upload some files. To achieve this use `-s3-include-files` and `-s3-exclude-files` flags. These flags accept https://en.wikipedia.org/wiki/Glob_(programming)[globs] such as `*.mp4`.
-
-=== S3 CLI Flags
-The following flags are supported by `selenoid` command when compiled with S3 support:
-
-```
--s3-access-key string
-    S3 access key
--s3-bucket-name string
-    S3 bucket name
--s3-endpoint string
-    S3 endpoint URL
--s3-exclude-files string
-    Pattern used to match and exclude files
--s3-force-path-style
-    Force path-style addressing for file upload
--s3-include-files string
-    Pattern used to match and include files    
--s3-keep-files
-    Do not remove uploaded files
--s3-key-pattern string
-    S3 bucket name (default "$fileName")
--s3-reduced-redundancy
-    Use reduced redundancy storage class
--s3-region string
-    S3 region
--s3-secret-key string
-    S3 secret key
-```
+Sometimes you may want to upload only video files or files matching some complicated pattern or to not upload some files. To achieve this use `-s3-include-files` and `-s3-exclude-files` flags. These flags accept https://en.wikipedia.org/wiki/Glob_(programming)[globs] such as `*.mp4`.