Merge pull request #23 from andock-ci/develop

Update documentation
andock-ci · Jul 20, 2018 · c3c43d5 · c3c43d5
2 parents 7b9493a + 05eb972
commit c3c43d5
Show file tree

Hide file tree

Showing 10 changed files with 81 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
-# andock-ci-pipeline (acp) - docksal remote control
+# andock(ci) - docksal and ansible powered hosting.
+
 ## What is andock?
-A command line tool managing remote docksal environments with ansible.   
+A docksal hosting solution.
+
+## What is andock pipeline?
+A command line tool for andock.   
+
 ## Key features
 * Easy to use command line tool.
 * Use ansible to remote control docksal.
@@ -16,7 +21,5 @@ A command line tool managing remote docksal environments with ansible.
 
 # Getting started?
 
-## Installation scenarios:
-
-* [Use inside docksal](https://andock-ci-pipeline.readthedocs.io/en/latest/getting-started/docksal/)
-* [Use on ci server](https://andock-ci-pipeline.readthedocs.io/en/latest/getting-started/ci/)
+* [See documentation](https://andock-ci-pipeline.readthedocs.io/en/latest/)
+* [5 minutes setup](https://andock-ci-pipeline.readthedocs.io/en/latest/docksal.md)
diff --git a/docs/configuration/build.md b/docs/configuration/build.md
@@ -0,0 +1,2 @@
+# Build configuration 
+@TODO
diff --git a/docs/getting-started/example-drupal-hooks.md → docs/configuration/example-drupal-hooks.md b/docs/getting-started/example-drupal-hooks.md → docs/configuration/example-drupal-hooks.md
diff --git a/docs/configuration/fin.md b/docs/configuration/fin.md
@@ -0,0 +1,2 @@
+# Fin configuration 
+@TODO
diff --git a/docs/configuration/overview.md b/docs/configuration/overview.md
@@ -0,0 +1,2 @@
+# Configuration overview 
+@TODO
diff --git a/docs/configuration/server.md b/docs/configuration/server.md
@@ -0,0 +1,2 @@
+# Server configuration 
+@TODO
diff --git a/docs/getting-started/docksal.md b/docs/getting-started/docksal.md
@@ -1,8 +1,11 @@
-# Setup instructions
+# 5 minutes setup instruction
 
-## 1. Installation
 
 [System requirements](/system-requirements.md)
+#### Install addon
+```
+fin addon install acp
+```
 #### Enable acp in your project
 ```
 fin acp enable
@@ -25,13 +28,13 @@ fin acp config:generate
 This will create some required config files and templates for init, build, test and update hooks. 
 #### Build project (optional)
 @TODO If you like to build your project and push it to target repository before you check it out on andock-ci server.
-[See](build.md)
+[See](./build.md)
 #### Initialize remote environment
 ```
 fin acp fin init
 ```
 
-#### Update remote environment
+#### Update remote environment  
 ```
 fin acp fin update
 ```
@@ -43,6 +46,7 @@ fin acp fin test
 
 ### Congratulations, the installation is finished!
 
-
-## Example hook configurations:
-1. [Drupal](example-drupal-hooks.md)
+### Read more:
+* [CI server automation](ci.md)
+### Example hook configurations:
+1. [Drupal](../configuration/example-drupal-hooks.md)
diff --git a/docs/getting-started/the-software.md b/docs/getting-started/the-software.md
@@ -0,0 +1,14 @@
+# What is andock.
+andock is a set of ansible roles to manage the complete build and deploy life cycle. and a command line tool to manage these ansible roles.
+
+## Life cycle
+* build
+* unit tests
+* Environment creation/updates
+* QA tests 
+* Environment removal
+
+## Ansible roles
+* server
+* build
+* fin
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,32 @@
-# andock-ci-pipeline (acp) - docksal remote control
+# andock(ci) - docksal and ansible powered hosting.
 
+## What is andock?
+A docksal hosting solution.
 
-##Installation scenarios:
+## What is andock pipeline?
+A command line tool for andock.   
+
+## For what can you use andock?
+* Host your project including environments support for every branch.
+* Host your project on acquia, platform.sh etc. Use andock for unlimited development environment.
+* Use andock to host review environments for qa suites. 
+## Do I need a ci server?
+No the easiest way is to use as a docksal addon. For further automation an CI is recommend. @TODO
+## How can I use andock
+* As docksal addon
+* As a docker image inside your CI
+* As a standalone command line tool.
+## Key features
+* Easy to use command line tool.
+* Use ansible to remote control docksal.
+* Easy configuration.
+* One environment per branch.
+* Extendable with init, update, tests ansible hooks.
+* drush support including drush sql-sync without extra ssh container.
+* Easy to integrate in your CI environment.
+
+
+## Getting started:
+* [5 minutes setup](getting-started/docksal.md)
 
-* [Use andock-ci with docksal](getting-started/docksal.md)
-* [Use docksal on your ci server](getting-started/ci.md)
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,7 +7,14 @@ markdown_extensions:
 pages:
   - Home: index.md
   - Getting started:
-    - Use with docksal: getting-started/docksal.md
-    - Use with ci: getting-started/ci.md
-    - Examples hook configurations:
-      - Drupal: getting-started/example-drupal-hooks.md
+    - What is andock: getting-started/the-software.md
+    - System requirements: getting-started/system-requirements.md
+    - 5 minutes setup: getting-started/docksal.md
+    - Automate on your ci: getting-started/ci.md
+  - Configuration:
+    - Overview: configuration/overview.md
+    - Hook configurations:
+      - Drupal: configuration/example-drupal-hooks.md
+    - Build configuration: configuration/build.md
+    - Fin configuration: configuration/fin.md
+    - Server configuration: configuration/fin.md