Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

    • This window display the Gerrit identifier (in this case 59893) associated to the change.
    • Next you will have to go to Gerrit at: gerrit.onap.org and login to Gerrit
    • You can then see the change you have made. Select that change. You will then need to "add" the name of the person to approve that change (i.e. DENG Hui)
          
    • Once the change has been committed, you will receive an email confirmation of the commit.
    • Note: If your commit and push fails for any reason, once you have fixed the problem, you can resend the request by selecting the "Amend (Edit previous commit)" icon in the Commit Message bar.


Output the ONAP Model

GenDoc

GenDoc is a tool that enables you to output the model to a Word document. See installation instructions on how to install the GenDoc plug-in.

Updating the GenDoc Template

  • A generic template is provided in the ONAP model in the GenDoc folder of the model you cloned from Gerrit.
  • The template is a Word document itself that contains GenDoc instructions. The template is called ONAP GenDoc Template. 
  • You can either open it in Eclipse by selecting the template, or you can open it up directly in Word by finding it in the folder where your model is stored.
  • There are 3 things in this template that you need to update
    1. Output file - This will be a Word document where GenDoc will store the output. 
             Image Added
    1. Diagram file - This is the model file where GenDoc will find the diagrams. Its' format is ".notation". The example below is going to output the diagrams in the Common sub-model
      Image Added
    2. Uml file - This is the model file where GenDoc will find the uml model artifacts. Its' format is ".uml". The example below is going to output all the Uml artifacts in the Common sub-mode

                   Image Added

Running the GenDoc Template

  • Once you have updated the GenDoc template, right click on the ONAP GenDoc Template file and select  the option "Generate documentation using Gendoc"
  • The GenDoc utility is invoked and the template is run. Once it has completed, you can find your output in the Output file you specified in the template.
  • Note: You do not want to "commit" to Gerrit the updated GenDoc template which contains your specific information.
  • As an alternative, you can create your own private folder for Gendoc template by selecting the option "File->New→Folder". Give the folder a name.
  • Then you can select "File->Import→ File System" and import the Gendoc template from your ONAP Information Model → Gendoc directory 
  • When you update this file you imported, it is now your own "private" copy. You can run the template using the same procedure described above.