Improve README markdown syntax 06/6106/1
authorecaiyanlinux <martin.c.yan@est.tech>
Fri, 21 May 2021 05:30:58 +0000 (13:30 +0800)
committerecaiyanlinux <martin.c.yan@est.tech>
Fri, 21 May 2021 05:32:55 +0000 (13:32 +0800)
Utilize markdown lint/preview tools to improve syntax

Signed-off-by: ecaiyanlinux <martin.c.yan@est.tech>
Issue-ID: NONRTRIC-517
Change-Id: Ib9a6e297ed1a4a0a8136df7c2549f61485de82e9

19 files changed:
sdnc-a1-controller/northbound/README.md
sdnc-a1-controller/northbound/features/README.md
sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md
sdnc-a1-controller/northbound/features/installer/README.md
sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md
sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md
sdnc-a1-controller/oam/README.md
sdnc-a1-controller/oam/installation/README.md
sdnc-a1-controller/oam/installation/sdnc-a1/README.md
sdnc-a1-controller/oam/installation/src/main/yaml/README.md
sdnc-a1-controller/oam/platform-logic/README.md
sdnc-a1-controller/oam/platform-logic/installer/README.md
sdnc-a1-controller/oam/platform-logic/setup/README.md

index 436f776..c8c696a 100644 (file)
@@ -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
 
index 5e0fae1..6d4bf1d 100644 (file)
@@ -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
 
index 2633949..7c65f9c 100644 (file)
@@ -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
 
index 1eaaa68..c189bad 100644 (file)
@@ -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
 
index 6bd2cc1..e6933de 100644 (file)
@@ -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
 
index 8a349d4..e58f6f0 100644 (file)
@@ -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
 
index 6b41cbd..d054e91 100644 (file)
@@ -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
 
index 2661993..544a24c 100644 (file)
@@ -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
 
index 54ab911..9802b29 100644 (file)
@@ -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
 
index 10f6790..4849134 100644 (file)
@@ -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
 
index 0cc666d..e4dfb16 100644 (file)
@@ -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
 
index 456b92f..a789a7f 100644 (file)
@@ -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
 
index 5f0619a..c366fa0 100644 (file)
@@ -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
 
index ce55f56..9880d7c 100644 (file)
@@ -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
 
index f9148d4..1153948 100644 (file)
@@ -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
 
index a82c70d..2957c86 100644 (file)
@@ -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
+<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:
-    #  - <path_to_keystore>:/etc/ssl/certs/java/keystore.jks:ro
-    #  - <path_to_truststore>:/etc/ssl/certs/java/truststore.jks:ro
-    #  - <path_to_https-props>:/opt/onap/sdnc/data/properties/https-props.properties:ro
+#      - <path_to_keystore>:/etc/ssl/certs/java/keystore.jks:ro
+#      - <path_to_truststore>:/etc/ssl/certs/java/truststore.jks:ro
+#      - <path_to_https-props>:/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
 
index e62e6b7..c2f4379 100644 (file)
@@ -1,6 +1,7 @@
 This module builds the submodule setup & installer
 
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
 
 ## License
 
index 5a11efd..174d3e5 100644 (file)
@@ -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
 
index b9d665d..3460c2e 100644 (file)
@@ -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