Add initial documentation.

andock-ci · Jul 20, 2018 · da5faf9 · da5faf9
1 parent 5341d9a
commit da5faf9
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 9 deletions.
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,6 +1,6 @@
 # Setup instructions
 
-## 1. Installation
+## Installation
 
 [System requirements](/system-requirements.md)
 #### Enable acp in your project
@@ -25,13 +25,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
 ```

diff --git a/docs/getting-started/the-software.md b/docs/getting-started/the-software.md
@@ -0,0 +1,3 @@
+# What is this software for.
+
+@TODO
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,12 @@
-# andock-ci-pipeline (acp) - docksal remote control
+# andock(ci) - docksal and ansible powered hosting.
 
+##What is andock
+@TODO
 
-##Installation scenarios:
+##Use cases
+@TODO
+
+##Installation scenarios
 
 * [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 this software for: getting-started/the-software.md
+    - System requirements: getting-started/system-requirements.md
+    - Docksal addon: 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