Uploaded image for project: 'IT: Release Engineering'
  1. IT: Release Engineering
  2. RELENG-509

Create Gerrit Documentation

Issue XMLXMLWordPrintable

    • RELENG Sprint 11, RELENG Sprint 12, RELENG Sprint 13, RELENG Sprint 14, RELENG Sprint 15, RELENG Sprint 18, RELENG Sprint 19, RELENG Sprint 20

      OpenDaylight has docs in several locations that should be consolidated into a single doc. It should explain to new developers how to use Gerrit.

      The OpenDaylight Gerrit Guide is an excellent starting resource [0] but we should probably pull relevant data from the OpenDaylight wiki links [1] too as well as any other place that sounds relevant and update the docs in places where it's out of date.

      This task should probably be split into smaller ones, we will leave this in the hands of someone taking on this task.

      The Gerrit Guide should explain the following topics:

      • How to clone code
      • How to push a new patch with git-review
        • How to Install git-review
      • How to update an existing patch with git-review
      • How to Code Review in Gerrit
        • DRAFTS vs Published patches
        • Merging a patch
      • Appendix
        • What is a DCO
        • How to setup your LFID account
        • How to generate SSH Key
        • How to use HTTPs as a fallback when SSH is blocked by network
        • How to sign commits with GPG
          • How to setup GPG for Mac Systems

      [0] http://docs.opendaylight.org/en/latest/gerrit.html
      [1] https://wiki.opendaylight.org/view/OpenDaylight_Controller:Gerrit_Setup
      [2] https://wiki.opendaylight.org/view/GettingStarted:Pulling,_Hacking,_and_Pushing_All_the_Code_from_the_CLI
      [3] https://wiki.opendaylight.org/view/OpenDaylight_Controller:Setting_up_HTTP_in_Gerrit

              jwagantall Jessica Wagantall
              zxiiro Thanh Ha
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: