Skip to content

Commit

Permalink
add guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stevensu1977 committed Sep 9, 2018
1 parent eeb5f02 commit 815a4f6
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Guide for develop flowqio scenario

* Scenario use docker-compose v2 format as enviroment profile

* Scenario use markdown format as content profile

* Add customization template feature



# A scenario structure

fixed name :

* docker-compose.yaml // envrionment profile

* index.json // content profile

* other file use markdown format , must be declar in index.json

envrionment :

* {OID} is scenarion instance creator id ,defualt use for docker-compose networks, storge config.

content:

* `git status`{{execute}} //{{execute}} will be creator click link, this link can be send to container instance.


## Scenarion Example - git-startup

[git-startup](https://github.com/flowqio/scenario/git-startup)

0 comments on commit 815a4f6

Please sign in to comment.