| commit | f41d154eb12583d1bac418d999e5df0360e8f3b3 | [log] [tgz] |
|---|---|---|
| author | Lusheng Ji <lji@research.att.com> | Tue Aug 29 14:15:42 2017 +0000 |
| committer | Lusheng Ji <lji@research.att.com> | Tue Aug 29 14:15:42 2017 +0000 |
| tree | 2ca526f0df573af4347366136d687e558d072d10 | |
| parent | 014a27a90d7ed4bf2f2c557ccfe02661a04d9655 [diff] |
Update LICENSE.txt Issue-Id: DCAEGEN2-86 Change-Id: If4ee27c214de84a422b331a0bcaa1f6738066a2d Signed-off-by: Lusheng Ji <lji@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