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

Migrate tutorial on git usage from trac/wiki to Confluence

    XMLWordPrintable

    Details

    • Team:
      SQuaRE

      Description

      Migrate the git tutorial on the trac/wiki (https://dev.lsstcorp.org/trac/wiki/GitDemoAndTutorial) to Confluence, as a chapter in the DM Developer Guide. Ensure that the migrated content is current and accurate; embellish where necessary, and omit historical content if it is not relevant.

        Attachments

          Activity

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

          K-T: the bulk of the git how-to material has been migrated to Confluence. There are still a couple of links to the trac/wiki, but it's not clear that it's worth migrating them. Let me know if you disagree.

          The main point of the review is to make sure that all of the relevant material is present in the Confluence page, that it is excised of stale or incorrect material, and that it ls likely to serve as a useful reference for developers as long as we use git.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - K-T: the bulk of the git how-to material has been migrated to Confluence. There are still a couple of links to the trac/wiki, but it's not clear that it's worth migrating them. Let me know if you disagree. The main point of the review is to make sure that all of the relevant material is present in the Confluence page, that it is excised of stale or incorrect material, and that it ls likely to serve as a useful reference for developers as long as we use git.
          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          Ahh, so the top of the page tree is: https://confluence.lsstcorp.org/display/LDMDG/LSST+Code+Repositories

          There is also a summary of git commands on the page:https://confluence.lsstcorp.org/display/LDMDG/Basic+Git+Operations

          but I think it is obviated by the other material. Let me know if you agree that it should be taken down.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - Ahh, so the top of the page tree is: https://confluence.lsstcorp.org/display/LDMDG/LSST+Code+Repositories There is also a summary of git commands on the page: https://confluence.lsstcorp.org/display/LDMDG/Basic+Git+Operations but I think it is obviated by the other material. Let me know if you agree that it should be taken down.
          Hide
          ktl Kian-Tat Lim added a comment -

          I've made a number of changes directly to the LSST Code Repositories page. I think more may need to be done in the workflow section, but I'm worried that that would diverge from the focus of the page on git (which is not well-reflected in its title).

          On Basic Git Operations, I think that this is a little duplicative but it does provide a useful reference. I'm not sure I'd say "add the file" takes you to "unmodified" – this is confusing both because I don't think you mean the "git add" command and because I'd consider a newly created file to actually be a modification. I think "git checkout -b" is used a lot more than "git checkout --track". You should note that "git pull" only works on the current branch while "git push" works on all local branches.

          Handling Git Merge Problems should be titled Handling Git Push Problems. But the content looks good.

          Gitolite Repository Hosting looks fine.

          I haven't looked through the complete Git Crash Course, but it looks like it's mostly copied from the Trac page and should be OK.

          Show
          ktl Kian-Tat Lim added a comment - I've made a number of changes directly to the LSST Code Repositories page. I think more may need to be done in the workflow section, but I'm worried that that would diverge from the focus of the page on git (which is not well-reflected in its title). On Basic Git Operations, I think that this is a little duplicative but it does provide a useful reference. I'm not sure I'd say "add the file" takes you to "unmodified" – this is confusing both because I don't think you mean the "git add" command and because I'd consider a newly created file to actually be a modification. I think "git checkout -b" is used a lot more than "git checkout --track". You should note that "git pull" only works on the current branch while "git push" works on all local branches. Handling Git Merge Problems should be titled Handling Git Push Problems. But the content looks good. Gitolite Repository Hosting looks fine. I haven't looked through the complete Git Crash Course, but it looks like it's mostly copied from the Trac page and should be OK.
          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          Thanks for the review, and the extensive corrections to the LSST Code Repositories page. It may well be that more work needs to be done on the "workflow" section, and I agree that this page seemed to have two themes: repositories and git usage. (You may recall that the content in most of the pages in this tree was drawn from only a couple of very long trac pages.) I've now moved the material related to git usage, policy, etc. to a new page: Using Git for LSST Development under this page tree. I also added a page tree to the end of the Code Repositories page.

          The material for Basic Git Operations was drawn from another internet resource that we reference elsewhere (I'd have to fish to recall which one). I did fix most of the problems you identified, but the figure comes from that other resource. I can remove the figure if you think it is too misleading.

          I changed the page title "Handling Git Merge Problems" to "...Git Push..."

          Let me know if further changes are needed before closing this issue.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - Thanks for the review, and the extensive corrections to the LSST Code Repositories page. It may well be that more work needs to be done on the "workflow" section, and I agree that this page seemed to have two themes: repositories and git usage . (You may recall that the content in most of the pages in this tree was drawn from only a couple of very long trac pages.) I've now moved the material related to git usage, policy, etc. to a new page: Using Git for LSST Development under this page tree. I also added a page tree to the end of the Code Repositories page. The material for Basic Git Operations was drawn from another internet resource that we reference elsewhere (I'd have to fish to recall which one). I did fix most of the problems you identified, but the figure comes from that other resource. I can remove the figure if you think it is too misleading. I changed the page title "Handling Git Merge Problems" to "...Git Push..." Let me know if further changes are needed before closing this issue.

            People

            Assignee:
            shaw Richard Shaw [X] (Inactive)
            Reporter:
            shaw Richard Shaw [X] (Inactive)
            Reviewers:
            Kian-Tat Lim
            Watchers:
            Kian-Tat Lim, Mario Juric, Richard Shaw [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: