| commit | 014a27a90d7ed4bf2f2c557ccfe02661a04d9655 | [log] [tgz] |
|---|---|---|
| author | Michael Hwang <mhwang@research.att.com> | Fri Dec 30 12:55:46 2016 -0500 |
| committer | Michael Hwang <mhwang@research.att.com> | Wed Aug 23 15:10:33 2017 -0400 |
| tree | 401a0e169602e42379f1ed9887678de24402aa72 | |
| parent | 487c0cc16cdca19c7014898eab240c0e3c913b85 [diff] |
Add dcae documentation repo Change-Id: I53662e0a1562d38775c878d6f257b50a125a998c Issue-Id: DCAEGEN2-81 Signed-off-by: Michael Hwang <mhwang@research.att.com>
Contains the public facing technical documentation for the dcae platform whose audiences include:
This is a Mkdocs project. To serve a local version of the documentation to view your changes:
Install mkdocs and mkdocs-material:
pip install mkdocs pip install mkdocs-material
Clone this repo
Run the following at the root of the cloned repo:
mkdocs serve
View the page at http://127.0.0.1:8000/
Generate the site:
mkdocs build
Build and push the Docker image - note the repository and group YOUR_NEXUS_DOCKER_REGISTRY/onap can be customized and replaced:
docker build -t YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest . docker push YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest
Run the Docker container:
export DOCKER_HOST=tcp://<target docker host> # REVIEW: Does this always pull latest? docker pull YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest docker run -d --name dpd -p 80:80 YOUR_NEXUS_DOCKER_REGISTRY/onap/dcae-platform-documentation:latest
