platformdoc/README.md

   1 # dcae-platform-documentation
   2
   3 Contains the public facing technical documentation for the dcae platform whose audiences include:
   4
   5 * Architects
   6 * Component developers
   7 * Operations (TBD)
   8
   9 ## Usage
  10
  11 ### Local dev
  12
  13 This is a [Mkdocs](http://www.mkdocs.org/) project.  To serve a local version of the documentation to view your changes:
  14
  15 1. Install mkdocs and mkdocs-material:
  16
  17     ```
  18     pip install mkdocs
  19     pip install mkdocs-material
  20     ```
  21
  22 2. Clone this repo
  23
  24 3. Run the following at the root of the cloned repo:
  25
  26     ```
  27     mkdocs serve
  28     ```
  29 4. View the page at `http://127.0.0.1:8000/`
  30
  31 ### Publish
  32
  33 1. Generate the site:
  34
  35     ```
  36     mkdocs build
  37     ```
  38
  39 2. Build the Docker image, tag as desired - eg `dcae-platform-documentation:YYYYMMDD`
  40
  41     ```
  42     docker build -t dcae-platform-documentation:20171002 .
  43     ```
  44
  45 3. Run the Docker container:
  46
  47     ```
  48     export DOCKER_HOST=tcp://<target docker host>
  49     docker stop dpd
  50     docker rm -f dpd
  51     docker run -d --name dpd -p 80:80 dcae-platform-documentation:YYYYMMDD
  52     ```
  53
  54 Or email Patty Heffner (ph8547@att.com)