sdnr/wt-odlux/readthedocs/README.md

   1 # SDNR/WT specific scripts to generate ReadTheDocs content
   2
   3 This repository is creating a maven artifact with SDNR readthedocs documents.
   4
   5 The repository is using the md and png files from "help app" input to create readthedocs structure with rst files.
   6 Further files are added from src directory of this maven project.
   7
   8 Script "convert.sh" is merging all information to "target/docs".
   9
  10 Build command: "mvn clean install"
  11
  12 Result for test purpose is bundled in a zip artifact (version may vary):
  13 ```
  14     <groupId>org.onap.ccsdk.features.sdnr.wt.sulfur.sr1</groupId>
  15     <artifactId>sdnr-wt-readthedocs-installer</artifactId>
  16     <version>1.4.0-SNAPSHOT</version>
  17 ```
  18
  19 ## 5GBerlin Test
  20
  21 The artifact is only used for doing a local test of the readme system.
  22
  23 ## ONAP gerrit
  24
  25 For synchronization with gerrit the output in target can be used: "target/docs".<br>
  26 The docs content has to be placed in ONAP/cssdk/features repository in docs content.
  27
  28 It is not a direct copy .. so only "target/docs" parts have to be copied over to "ONAP gerrit:cssdk/features/docs"
  29
  30 ONAP/gerrit has its own propess of creating the ONAP Readthedocs.
  31
  32 ## Places
  33
  34
  35 ### sdnr/wt/readthedocs
  36  Scripts and source data for creation of documentation.
  37
  38  Other sources are located in related implementation directory
  39
  40 ### docs
  41  destination of documentation files to be placed in a SDNC repository.
  42  Fully created by script. <- Stimmt nicht