Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-5157

POLICY: Removing outdated pages from dev docs

    XMLWordPrintable

    Details

      Description

      There are number of pages in dev docs that are completely outdated for one of the reasons:

      • they refer to API that no longer exist in supported versions
      • they discuss [old] specification that was not implemented or was implemented differently
      • they are just overall confusing and better docs exist

      This is what we should do:

      1. Edit the page and remove the old info (or the whole text completely).
      2. Leave a message explaining why it was nuked, point to the new page and say the old text is available in the history.
      3. Remove from all categories
      4. Make sure no other page in dev docs links to it
      5. Optional: comment on this issue with the link to the removed page. This is only if you feel that there is a slight possibility that old text may be useful.
      6. Optional: link to this issue from the message from #2 above.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              marina Marina Glancy
              Participants:
              Component watchers:
              Adrian Greeve, Marina Glancy
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: