Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-1207

Migrate general coding standards docs from Trac to Confluence

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: SAT
    • Labels:
    • Team:
      SQuaRE

      Description

      Migrate the Trac documents on DM Coding Style Policy (https://confluence.lsstcorp.org/display/LDMDG/DM+Coding+Style+Policy)
      as well as the top-level Standards and Policies page (https://confluence.lsstcorp.org/display/LDMDG/Standards+and+Policies) to to the DM Developer Guide.

        Attachments

          Issue Links

            Activity

            Hide
            shaw Richard Shaw [X] (Inactive) added a comment -

            These documents should be reviewed to ensure that all intended content was migrated correctly, and that the Confluence formatting is acceptable. The Coding Style Policy page contains a back-link to the Trac page, which will be removed after a successful review. Also, the content on the Trac page can be deleted if that is desired.

            Show
            shaw Richard Shaw [X] (Inactive) added a comment - These documents should be reviewed to ensure that all intended content was migrated correctly, and that the Confluence formatting is acceptable. The Coding Style Policy page contains a back-link to the Trac page, which will be removed after a successful review. Also, the content on the Trac page can be deleted if that is desired.
            Hide
            robyn Robyn Allsman [X] (Inactive) added a comment -

            Status update: a review of the Trac index (95 pages worth) yielded 5 pages worth of trac docs which should be transferred to Confluence. The majority of those documents are related to policies, guidelines, how-to's. About 3 pages worth of such info remains to be transferred. Many of these documents need to be updated for the current developer environment and workflow. Some of that is happening as the document is transferred.

            IMHO, the critical files have already been transferred: the Language and Documentation Guides, the SW licensing info, key policies, and pointers to the old TCT meetings.

            The full index has been re-categorized to group subject matter together. On completion of the 5 pages of policies, etc, the individuals responsible for the other 90 pages worth of data will be notified so that they can move critical files over to Confluence or risk the danger of bit-rot setting in over time.

            I recommend that after this initial transfer is complete, the trac documents become read-only and the Trac logging mechanism start log every access to trac documents (instead of only those that fail). That way, an audit 6 months later can determine what files are additional candidate for xfer to Confluence.

            Show
            robyn Robyn Allsman [X] (Inactive) added a comment - Status update: a review of the Trac index (95 pages worth) yielded 5 pages worth of trac docs which should be transferred to Confluence. The majority of those documents are related to policies, guidelines, how-to's. About 3 pages worth of such info remains to be transferred. Many of these documents need to be updated for the current developer environment and workflow. Some of that is happening as the document is transferred. IMHO, the critical files have already been transferred: the Language and Documentation Guides, the SW licensing info, key policies, and pointers to the old TCT meetings. The full index has been re-categorized to group subject matter together. On completion of the 5 pages of policies, etc, the individuals responsible for the other 90 pages worth of data will be notified so that they can move critical files over to Confluence or risk the danger of bit-rot setting in over time. I recommend that after this initial transfer is complete, the trac documents become read-only and the Trac logging mechanism start log every access to trac documents (instead of only those that fail). That way, an audit 6 months later can determine what files are additional candidate for xfer to Confluence.
            Hide
            robyn Robyn Allsman [X] (Inactive) added a comment -

            Read the comments on DM-272 for a detailed status update on the move of RELEVANT trac pages to confluence.

            Show
            robyn Robyn Allsman [X] (Inactive) added a comment - Read the comments on DM-272 for a detailed status update on the move of RELEVANT trac pages to confluence.
            Hide
            robyn Robyn Allsman [X] (Inactive) added a comment - - edited

            This files relevant to general coding standards have been reviewed for format and consistent style. The content seems to have been accurately transferred but I did not do a word for word comparison. The ones that I read and recently had to update on behalf of the TCT were correct.

            Show
            robyn Robyn Allsman [X] (Inactive) added a comment - - edited This files relevant to general coding standards have been reviewed for format and consistent style. The content seems to have been accurately transferred but I did not do a word for word comparison. The ones that I read and recently had to update on behalf of the TCT were correct.

              People

              • Assignee:
                robyn Robyn Allsman [X] (Inactive)
                Reporter:
                shaw Richard Shaw [X] (Inactive)
                Reviewers:
                Jim Bosch, Kian-Tat Lim
                Watchers:
                Frossie Economou, Kian-Tat Lim, Richard Shaw [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel