Uploaded image for project: 'Policy Framework'
  1. Policy Framework
  2. POLICY-2511

policy framework documentation: decrease/remove warnings in rst files

XMLWordPrintable

      Currently there are approx. 918 WARNINGS at all, most of them are because of RST format/syntax errors. A relevant number of those warnings (approx. 94) are caused by documentation for the ONAP Policy Framework.
      To be more concrete, i have added parts of a logfile that show some statistics about projects/modules, rst-files and the related number of warnings they are responsible for:

      ################################################################################
      ~~~ MODULES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      ################################################################################

      00918 WARNINGS IN TOTAL IN 42 MODULES
      00135 | dcaegen2.git
      00094 | policy
      00091 | ccsdk
      00052 | dmaap
      00047 | multicloud
      ...

      ################################################################################
      ~~~ MODULES WITH RSTFILES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      ################################################################################

      00918 WARNINGS IN TOTAL IN APPROX. 318 RST FILES
      ...
      policy | APEX-DecisionMakerExample.rst | rst html web doc8_(00072) | 00002
      policy | APEX-Install-Guide.rst | rst html web doc8_(00149) | 00001
      policy | APEX-MyFirstPolicyExample.rst | rst html web doc8_(00017) | 00035
      policy | APEX-PCVS-Example.rst | rst html web doc8_(00017) | 00023
      policy | APEX-User-Manual.rst | rst html web doc8_(00150) | 00005
      policy | api.rst | rst html web doc8_(00050) | 00001
      policy | architecture.rst | rst html web doc8_(00015) | 00004
      policy | design.rst | rst html web doc8_(00206) | 00001
      policy | development.rst | rst html web doc8_(00001) | 00001
      policy | devtools.rst | rst html web doc8_(00021) | 00001
      policy | index.rst | rst html web doc8_(00024) | 00002
      policy | installation.rst | rst html web doc8_(00072) | 00001
      policy | installBeijingController.rst | rst html web doc8_(00272) | 00001
      policy | InternalPapPdp.rst | rst html web doc8_(00070) | 00001
      policy | modTemplate.rst | rst html web doc8_(00018) | 00001
      policy | offeredapis.rst | rst html web doc8_(00017) | 00002
      policy | oom.rst | rst html web doc8_(00029) | 00003
      policy | release-notes.rst | rst html web doc8_(00070) | 00001
      policy | runningEclipse.rst | rst html web doc8_(00007) | 00001
      policy | tosca-policy-primer.rst | rst html web doc8_(00027) | 00001
      policy | xacml.rst | rst html web doc8_(00024) | 00002
      policy | xacml-tutorial.rst | rst html web doc8_(00029) | 00004
      ...

      Do you and your team see a chance to fix the problems in the Policy Framework documentation files?

            pdragosh pdragosh
            thmsdt Thomas Kulik
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: