diff options
author | Lusheng Ji <lji@research.att.com> | 2017-09-11 23:38:09 +0000 |
---|---|---|
committer | Lusheng Ji <lji@research.att.com> | 2017-09-12 01:42:11 +0000 |
commit | 1694802295e445771fe32bd3a14fefb53e3ab9fa (patch) | |
tree | 143e17efc193611ed1795e4c77ca2fdef028c818 /platformdoc/README.md | |
parent | 64472de4c2e2acc7bf883a3e8267ad5aa38e2cb0 (diff) |
Make platformdoc docker container
Issue-Id: DCAEGEN2-60
Change-Id: Id57ab539707a43883ff957a23d2459a9b12df22e
Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'platformdoc/README.md')
-rw-r--r-- | platformdoc/README.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/platformdoc/README.md b/platformdoc/README.md new file mode 100644 index 00000000..917c087f --- /dev/null +++ b/platformdoc/README.md @@ -0,0 +1,53 @@ +# dcae-platform-documentation + +Contains the public facing technical documentation for the dcae platform whose audiences include: + +* Architects +* Component developers +* Operations + +## 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 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 + ``` + +3. 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 + ``` + |