diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CBA/index.rst | 64 | ||||
| -rw-r--r-- | docs/CBA/sections/development/index.rst | 26 | ||||
| -rw-r--r-- | docs/CBA/sections/installation/index.rst | 47 | ||||
| -rw-r--r-- | docs/datadictionary/index.rst | 38 |
4 files changed, 73 insertions, 102 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst index 957c71eb9..c70f0972f 100644 --- a/docs/CBA/index.rst +++ b/docs/CBA/index.rst @@ -31,20 +31,64 @@ Architecture: Installation: ============= -.. toctree:: - :maxdepth: 1 - :glob: - - sections/installation/index +Building client html and js files +================================= + + * FROM alpine:3.8 as builder + + * RUN apk add --no-cache npm + + * WORKDIR /opt/cds-ui/client/ + + * COPY client/package.json /opt/cds-ui/client/ + + * RUN npm install + + * COPY client /opt/cds-ui/client/ + + * RUN npm run build + + +Building and creating server +============================ + + * FROM alpine:3.8 + + * WORKDIR /opt/cds-ui/ + + * RUN apk add --no-cache npm + + * COPY server/package.json /opt/cds-ui/ + + * RUN npm install + + * COPY server /opt/cds-ui/ + + * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public + + * RUN npm run build + + * EXPOSE 3000 + + * CMD [ "npm", "start" ] Development: ============= -.. toctree:: - :maxdepth: 1 - :glob: - - sections/development/index +Pre-requiste: +============= + Visual Studio code editor + Git bash + +Steps +===== + To compile CDS code: + + 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains + references to the ONAP repositories and OpenDaylight repositories. + 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds + 3. cd cds ; mvn clean install ; cd .. + 4. Open the cds-ui/client code for development Data Flow: ========== diff --git a/docs/CBA/sections/development/index.rst b/docs/CBA/sections/development/index.rst deleted file mode 100644 index dc61a238c..000000000 --- a/docs/CBA/sections/development/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2019 IBM. - -Development ------------- -.. toctree:: - :maxdepth: 1 - -Pre-requiste: -============= - Visual Studio code editor - Git bash - -Steps -===== - To compile CDS code: - - 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains - references to the ONAP repositories and OpenDaylight repositories. - 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds - 3. cd cds ; mvn clean install ; cd .. - 4. Open the cds-ui/client code for development - - - diff --git a/docs/CBA/sections/installation/index.rst b/docs/CBA/sections/installation/index.rst deleted file mode 100644 index eb7676d08..000000000 --- a/docs/CBA/sections/installation/index.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2019 IBM. - -Installation ------------- - -Building client html and js files -================================= - - * FROM alpine:3.8 as builder - - * RUN apk add --no-cache npm - - * WORKDIR /opt/cds-ui/client/ - - * COPY client/package.json /opt/cds-ui/client/ - - * RUN npm install - - * COPY client /opt/cds-ui/client/ - - * RUN npm run build - - -Building and creating server -============================ - - * FROM alpine:3.8 - - * WORKDIR /opt/cds-ui/ - - * RUN apk add --no-cache npm - - * COPY server/package.json /opt/cds-ui/ - - * RUN npm install - - * COPY server /opt/cds-ui/ - - * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public - - * RUN npm run build - - * EXPOSE 3000 - - * CMD [ "npm", "start" ]
\ No newline at end of file diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst index 3243fd23f..83c6e47b8 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -2,44 +2,44 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -Data Dictionary ----------------- +Resource Definition +------------------- .. toctree:: :maxdepth: 1 Introduction: ============= -A data dictionary defines a specifc resource that can be resolved using the bellow supported sources. +A Resource Definition defines a specifc resource that can be resolved using the bellow supported sources. -A data dictionary can support multiple sources. +A Resource Definition can support multiple sources. -The main goal of data dictionary is to define generic entity that could be shared accross services. +The main goal of Resource Definition is to define generic entity that could be shared accross services. Resolution sources: =================== - Input - Default - DB - REST - Capability + * Input + * Default + * DB + * REST + * Capability Artifacts: ========== - artifact-mapping-resource - artifact-template-velocity - artifact-directed-graph - + * artifact-mapping-resource + * artifact-template-velocity + * artifact-directed-graph Node type: ========== - component-resource-resolution - component-jython-executor - component-netconf-executor - component-restconf-executor + + * component-resource-resolution + * component-jython-executor + * component-netconf-executor + * component-restconf-executor Data type: ========== - vnf-netconf-device
\ No newline at end of file + * vnf-netconf-device
\ No newline at end of file |