diff options
Diffstat (limited to 'platformdoc/README.md')
| -rw-r--r-- | platformdoc/README.md | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/platformdoc/README.md b/platformdoc/README.md deleted file mode 100644 index 8c4c5996..00000000 --- a/platformdoc/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# dcae-platform-documentation - -Contains the public facing technical documentation for the dcae platform whose audiences include: - -* Architects -* Component developers -* Operations (TBD) - -## Usage - -### Local dev - -This is a [Mkdocs](http://www.mkdocs.org/) project. To serve a local version of the documentation to view your changes: - -1. Install mkdocs and mkdocs-material: - - ``` - pip install mkdocs - pip install mkdocs-material - ``` - -2. Clone this repo - -3. Run the following at the root of the cloned repo: - - ``` - mkdocs serve - ``` -4. View the page at `http://127.0.0.1:8000/` - -### Publish - -1. Generate the site: - - ``` - mkdocs build - ``` - -2. Build the Docker image, tag as desired - eg `dcae-platform-documentation:YYYYMMDD` - - ``` - docker build -t dcae-platform-documentation:20171002 . - ``` - -3. Run the Docker container: - - ``` - export DOCKER_HOST=tcp://<target docker host> - docker stop dpd - docker rm -f dpd - docker run -d --name dpd -p 80:80 dcae-platform-documentation:YYYYMMDD - ``` - -Or email Patty Heffner (ph8547@att.com) |