diff options
Diffstat (limited to 'csarvalidation/README.md')
| -rw-r--r-- | csarvalidation/README.md | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/csarvalidation/README.md b/csarvalidation/README.md index d940d1d..65c12fb 100644 --- a/csarvalidation/README.md +++ b/csarvalidation/README.md @@ -77,7 +77,14 @@ How to configure vnfreqs.properties How to run CSAR validation -------------------------- -Follow the setups given below to run as csar-validate command +Follow the setups given below to run as csar-validate command. + +<u><b>Warning !!!</b> +Be default, during project building, documentation generation is being disabled +(see point "Documentation generation" for more details).</u> +In order to enable this process, add parameter `-DskipDocsGeneration=false` to mvn command, example: +`mvn clean package -DskipDocsGeneration=false` + 1. Install OCLIP (`wget -O - https://raw.githubusercontent.com/onap/cli/master/deployment/zip/installer/install-latest.sh | sh`) @@ -85,6 +92,13 @@ Follow the setups given below to run as csar-validate command 3. Run `oclip --product onap-vtp csar-validate --csar <CSAR path>` +Documentation generation +-------------------------- +During project build, automated generation of tables, containing supported rules, is being performed. +Created tables are being saved in target directory, `target/generated-docs/{current_release}`. +This generation is being performed by `exec-maven-plugin`, defined in pom.xml. +In order to generate tables <b>python3 and pip3 are required</b>. + Contact ------- -Kanagaraj.Manickam@huawei.com
\ No newline at end of file +Kanagaraj.Manickam@huawei.com |