Uploaded image for project: 'VOLTHA'
  1. VOLTHA
  2. VOL-5079

docs.voltha.org: voltha-openonu-adapter-go/docs broken when voltha-protos source updated

    XMLWordPrintable

    Details

    • Type: Task
    • Status: To Do (View Workflow)
    • Priority: Low
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Story Points:
      0

      Description

      Source lines in extensions.proto no longer match up with URL anchors.

      This problem will manifest in repo:voltha-docs which includes voltha-openonu-adapter-go as a sub=module:

       

      git clone repo:voltha-docs

      % make test | grep broken

      (voltha-openonu-adapter-go/docs/PM_Notes: line  311) broken    https://github.com/opencord/voltha-protos/blob/master/protos/voltha_protos/extensions.proto#L157 - Anchor 'L157' not found
      
      (overview/architecture_overview: line   69) ok        https://github.com/opencord/voltha-protos/blob/master/protos/voltha_protos/openolt.proto
      
      (voltha-openonu-adapter-go/docs/PM_Notes: line  287) broken    https://github.com/opencord/voltha-protos/blob/master/protos/voltha_protos/extensions.proto#L259 - Anchor 'L259' not found
      
      (voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes: line   69) broken    https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L106 - Anchor 'L106' not found
      
      (voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes: line   71) broken    https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L116 - Anchor 'L116' not found
      
      (release_notes/voltha_2.6: line  154) ok        https://github.com/opencord/voltha-protos/releases/tag/v4.0.5
      
      (voltha-openonu-adapter-go/docs/PM_Notes: line   15) broken    https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L61 - Anchor 'L61' not found
      
      (voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes: line   70) broken    https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L125 - Anchor 'L125' not found
      
      

      https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master

      Failing URLs are currenlty being excluded by repo:voltha-docs/sphinx_conf/linkcheck_ignore.py.
      URL exclusions should be deleted after doc content has been cleaned up on repo:voltha-openonu-adapter.go

       

       

       

        Attachments

        # Subject Branch Project Status CR V

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            joey Joey Armstrong
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes