From: ecaiyanlinux Date: Fri, 21 May 2021 05:30:58 +0000 (+0800) Subject: Improve README markdown syntax X-Git-Tag: 2.2.0~37 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=4fea8f622cd8095003e6310b94bc860ec2481ec4;p=nonrtric.git Improve README markdown syntax Utilize markdown lint/preview tools to improve syntax Signed-off-by: ecaiyanlinux Issue-ID: NONRTRIC-517 Change-Id: Ib9a6e297ed1a4a0a8136df7c2549f61485de82e9 --- diff --git a/sdnc-a1-controller/northbound/README.md b/sdnc-a1-controller/northbound/README.md index 436f7766..c8c696a1 100644 --- a/sdnc-a1-controller/northbound/README.md +++ b/sdnc-a1-controller/northbound/README.md @@ -1,6 +1,7 @@ This module builds the sdnc-a1-northbound which inturn creates the nonrt-ric-api-provider & nonrt-ric-api-model bundles. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/features/README.md b/sdnc-a1-controller/northbound/features/README.md index 5e0fae11..6d4bf1d2 100644 --- a/sdnc-a1-controller/northbound/features/README.md +++ b/sdnc-a1-controller/northbound/features/README.md @@ -1,6 +1,7 @@ This module builds the submodule sdnc-a1-northbound-all,features-sdnc-a1-northbound & installer which creates the features & installers which can be installed in Karaf Server. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md b/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md index 26339496..7c65f9ca 100644 --- a/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md +++ b/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md @@ -1,6 +1,7 @@ This module creates features-sdnc-a1-northbound features from sdnc-a1-northbound-all feature. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/features/installer/README.md b/sdnc-a1-controller/northbound/features/installer/README.md index 1eaaa688..c189bad5 100644 --- a/sdnc-a1-controller/northbound/features/installer/README.md +++ b/sdnc-a1-controller/northbound/features/installer/README.md @@ -1,6 +1,7 @@ This module is responsible for creating sdnc-a1-northbound-features-installer installer which contains sdnc-a1-northbound-all feature. This is then installed into Karaf Server when deployed. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md b/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md index 6bd2cc14..e6933dee 100644 --- a/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md +++ b/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md @@ -1,6 +1,7 @@ This module creates the sdnc-a1-northbound-all feature from sdnc-nonrt-ric-api feature. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/README.md index 8a349d4b..e58f6f08 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/README.md @@ -1,6 +1,7 @@ This module builds the model, provider, install & features to create the bundles, features & installers. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md index 6b41cbdd..d054e910 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md @@ -1,6 +1,7 @@ This module builds the two submodules sdnc-nonrt-ric-api & features-nonrt-ric-api which creates the A1 northbound feature. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md index 26619937..544a24c5 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md @@ -1,6 +1,7 @@ This module creates the features-nonrt-ric-api feature from sdnc-nonrt-ric-api feature -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md index 54ab9119..9802b292 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md @@ -1,6 +1,7 @@ This module creates the sdnc-nonrt-ric-api feature from the nonrt-ric-api-model & nonrt-ric-api-provider bundles. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md index 10f6790c..48491343 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md @@ -1,6 +1,7 @@ This module installs the sdnc-nonrt-ric-api feature into the Karaf Server. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md index 0cc666d2..e4dfb163 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md @@ -1,6 +1,7 @@ This module contains the yang definition of the A1 northbound API and creates the nonrt-ric-api-model bundle. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md index 456b92fa..a789a7f2 100644 --- a/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md @@ -1,6 +1,7 @@ This module provides the implementation for the A1 Northbound API and creates the nonrt-ric-api-provider bundle. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/README.md b/sdnc-a1-controller/oam/README.md index 5f0619a1..c366fa0f 100644 --- a/sdnc-a1-controller/oam/README.md +++ b/sdnc-a1-controller/oam/README.md @@ -1,6 +1,7 @@ This module builds the submodule sdnc-a1 which inturn creates the SDNC A1 docker image -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/installation/README.md b/sdnc-a1-controller/oam/installation/README.md index ce55f565..9880d7ce 100644 --- a/sdnc-a1-controller/oam/installation/README.md +++ b/sdnc-a1-controller/oam/installation/README.md @@ -6,7 +6,8 @@ It also contains the keystore, the script to start OpenDaylight, and the healthc The docker-compose file is also included in this directory. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/installation/sdnc-a1/README.md b/sdnc-a1-controller/oam/installation/sdnc-a1/README.md index f9148d48..11539488 100644 --- a/sdnc-a1-controller/oam/installation/sdnc-a1/README.md +++ b/sdnc-a1-controller/oam/installation/sdnc-a1/README.md @@ -1,6 +1,7 @@ This module is responsible for creating Docker images. The feature installers are added into the docker images so that it can be installed in karaf server. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/installation/src/main/yaml/README.md b/sdnc-a1-controller/oam/installation/src/main/yaml/README.md index a82c70df..2957c868 100644 --- a/sdnc-a1-controller/oam/installation/src/main/yaml/README.md +++ b/sdnc-a1-controller/oam/installation/src/main/yaml/README.md @@ -1,27 +1,30 @@ The SDNC-A1 controller uses the default keystore and truststore that are built into the container. The paths and passwords for these stores are located in a properties file: -nonrtric/sdnc-a1-controller/oam/installation/src/main/properties/https-props.properties +`nonrtric/sdnc-a1-controller/oam/installation/src/main/properties/https-props.properties` The default truststore includes the a1simulator cert as a trusted cert which is located here: -https://gerrit.o-ran-sc.org/r/gitweb?p=sim/a1-interface.git;a=tree;f=near-rt-ric-simulator/certificate;h=172c1e5aacd52d760e4416288dc5648a5817ce65;hb=HEAD + The default keystore, truststore, and https-props.properties files can be overridden by mounting new files using the "volumes" field of docker-compose. Uncommment the following lines in docker-compose to do this, and provide paths to the new files: +```yaml #volumes: - # - :/etc/ssl/certs/java/keystore.jks:ro - # - :/etc/ssl/certs/java/truststore.jks:ro - # - :/opt/onap/sdnc/data/properties/https-props.properties:ro +# - :/etc/ssl/certs/java/keystore.jks:ro +# - :/etc/ssl/certs/java/truststore.jks:ro +# - :/opt/onap/sdnc/data/properties/https-props.properties:ro +``` The target paths in the container should not be modified. For example, assuming that the keystore, truststore, and https-props.properties files are located in the same directory as docker-compose: +```yaml volumes: - ./new_keystore.jks:/etc/ssl/certs/java/keystore.jks:ro - ./new_truststore.jks:/etc/ssl/certs/java/truststore.jks:ro - ./new_https-props.properties:/opt/onap/sdnc/data/properties/https-props.properties:ro - +``` ## License diff --git a/sdnc-a1-controller/oam/platform-logic/README.md b/sdnc-a1-controller/oam/platform-logic/README.md index e62e6b72..c2f43793 100644 --- a/sdnc-a1-controller/oam/platform-logic/README.md +++ b/sdnc-a1-controller/oam/platform-logic/README.md @@ -1,6 +1,7 @@ This module builds the submodule setup & installer -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/platform-logic/installer/README.md b/sdnc-a1-controller/oam/platform-logic/installer/README.md index 5a11efdb..174d3e5e 100644 --- a/sdnc-a1-controller/oam/platform-logic/installer/README.md +++ b/sdnc-a1-controller/oam/platform-logic/installer/README.md @@ -1,6 +1,7 @@ This module builds the platform-logic-installer which contains the DG's but A1 controller in O-RAN doesn't support DG. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License diff --git a/sdnc-a1-controller/oam/platform-logic/setup/README.md b/sdnc-a1-controller/oam/platform-logic/setup/README.md index b9d665dc..3460c2e4 100644 --- a/sdnc-a1-controller/oam/platform-logic/setup/README.md +++ b/sdnc-a1-controller/oam/platform-logic/setup/README.md @@ -1,6 +1,7 @@ This module should contains the Directed Graphs (DG) but A1 controller in O-RAN doesn't support DG. -To compile, run "mvn clean install". +To compile, run +>`mvn clean install` ## License