Uploaded image for project: 'Service Orchestrator'
  1. Service Orchestrator
  2. SO-319

unknown directives in documentations

XMLWordPrintable

      several errors occur when performing doc8 check on so documentation

      docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/CHANGELOG.txt:3: ERROR: Unexpected indentation.
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/nova-net.rst:44: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/nova-net.rst:47: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:10: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:15: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:22: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:25: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:28: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:31: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:34: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:37: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:40: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:43: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:46: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:49: ERROR: Unknown directive type "cfy:node".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:144: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:149: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:154: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:157: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:166: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:171: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:176: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:181: ERROR: Unknown directive type "cfy:rel".
      [..]/ONAP/doc/docs/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/types.rst:186: ERROR: Unknown directive type "cfy:rel".

      cfy:rel and cfy:node are unknown

      it seems that some links are also not correct, see renderer http://onap.readthedocs.io/en/latest/submodules/so.git/aria/multivim-plugin/src/main/python/multivim-plugin/docs/nova-net.html?highlight=nova%20net%20support

      I do not understand the meaning of

      This is why you may notice two separate types defined for [Floating](#cloudifyopenstacknodesfloatingip) [IP](#cloudifyopenstacknovanetnodesfloatingip), as well as for [Security](#cloudifyopenstacknodessecuritygroup) [Group](#cloudifyopenstacknovanetnodessecuritygroup).

       

       

            dfilppi dfilppi
            mrichomme mrichomme
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: