blob: 917c087f566e3b0ed29ced57e7d854506c26d644 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
```
|
