Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOC-263

All scripts in ReadTheDocs must be tested and copied from an actual deployment - just like any other code review

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Medium Medium
    • None
    • Beijing Release
    • None
    • None

      OOM-1016 is only one example

      Some scripts over the last while that are in the documentation have not been actually executed.
      Any documentation that contains runnable code must go through the same process that code goes through - demonstrate an actual run of the code with results

      Best practice is to only paste directly from a console window - don't write scripts freehand
      Also when appropriating content from the wiki - rerun it.

      also see comment on
      https://wiki.onap.org/display/DW/Doc+Project+Meetings

            michaelobrien michaelobrien
            michaelobrien michaelobrien
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: