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
   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 3. Run the following at the root of the cloned repo:
  24
  25     ```
  26     mkdocs serve
  27     ```
  28 4. View the page at `http://127.0.0.1:8000/`
  29
  30 ### Publish
  31
  32 1. Generate the site:
  33
  34     ```
  35     mkdocs build
  36     ```
  37
  38 2. Build and push the Docker image - note the repository and group `YOUR_NEXUS_DOCKER_REGISTRY/onap` can be customized and replaced:
  39
  40     ```
  41     docker build -t YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest .
  42     docker push YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest
  43     ```
  44
  45 3. Run the Docker container:
  46
  47     ```
  48     export DOCKER_HOST=tcp://<target docker host>
  49     # REVIEW: Does this always pull latest?
  50     docker pull YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest
  51     docker run -d --name dpd -p 80:80 YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest
  52     ```
  53