Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
christianwiedemann committed Jul 20, 2018
1 parent da5faf9 commit dfcfd2a
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 14 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# 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.

## 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.

## Key features
* Easy to use command line tool.
* Use ansible to remote control docksal.
Expand All @@ -16,7 +26,4 @@ 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/)
27 changes: 20 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# andock(ci) - docksal and ansible powered hosting.

##What is andock
@TODO
## What is andock?
A docksal hosting solution.

##Use cases
@TODO
## What is andock pipeline?
A command line tool for andock.

##Installation scenarios
## 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.

## 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)

2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pages:
- Getting started:
- What is this software for: getting-started/the-software.md
- System requirements: getting-started/system-requirements.md
- Docksal addon: getting-started/docksal.md
- 5 minutes setup: getting-started/docksal.md
- Automate on your ci: getting-started/ci.md
- Configuration:
- Overview: configuration/overview.md
Expand Down

0 comments on commit dfcfd2a

Please sign in to comment.