Merge ~raharper/cloud-init:doc/update-hacking-docs into cloud-init:master

[Ryan Harper]

doc: update launchpad git refs to github

[Chad Smith (chad.smith)]

minor corrections here. thanks!

review: Needs Fixing

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:3776f25d65c2eacce6ad244c3fd37c168782ccfb
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1278/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1278//rebuild

review: Approve (continuous-integration)

72b25f0... by Ryan Harper on 2019-11-07

Tell users to fork from GitHub account first, fix clone url

[Chad Smith (chad.smith)]

Perfect.

review: Approve

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:72b25f05d4c0ff35e6c370244b1069c2c7fcfc18
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1279/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1279//rebuild

review: Approve (continuous-integration)

diff --git a/HACKING.rst b/HACKING.rst
index fcdfa4f..8c8e518 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -3,18 +3,40 @@ Hacking on cloud-init
 *********************
 
 This document describes how to contribute changes to cloud-init.
-It assumes you have a `Launchpad`_ account, and refers to your launchpad user
-as ``LP_USER`` throughout.
+It assumes you have a `GitHub`_ account, and refers to your GitHub user
+as ``GH_USER`` throughout.
 
 Do these things once
 ====================
 
 * To contribute, you must sign the Canonical `contributor license agreement`_
 
-  If you have already signed it as an individual, your Launchpad user will be listed in the `contributor-agreement-canonical`_ group.  Unfortunately there is no easy way to check if an organization or company you are doing work for has signed.  If you are unsure or have questions, email `Josh Powers <mailto:[e-mail]>`_ or ping powersj in ``#cloud-init`` channel via freenode.
+  If you have already signed it as an individual, your Launchpad user will be
+  listed in the `contributor-agreement-canonical`_ group.  Unfortunately there
+  is no easy way to check if an organization or company you are doing work for
+  has signed.  When signing the CLA and prompted for 'Project contact' or
+  'Canonical Project Manager' enter 'Josh Powers'.
 
-  When prompted for 'Project contact' or 'Canonical Project Manager' enter
-  'Josh Powers'.
+  For existing contributors who've already signed the agreement, we can verify
+  the link between your `Launchpad`_ account and your `GitHub`_ account by
+  creating a branch with both your Launchpad and GitHub usernames into both
+  Launchpad and GitHub cloud-init repositories.  We've added a tool
+  (tools/migrate-lp-user-to-github) to the cloud-init repository to handle this
+  migration as automatically as possible.
+
+  The cloud-init team will review the two merge proposals and verify
+  that the CLA has been signed for the Launchpad user and record the
+  associated GitHub account.  We will reply to the email address
+  associated with your Launchpad account that you've been clear to
+  contribute to cloud-init on GitHub.
+
+  If your company has signed the CLA for you, please contact us to help
+  in verifying which launchad/GitHub accounts are associated with the
+  company.  For any questions or help with the process, please email:
+
+  `Josh Powers <mailto:[e-mail]>`_ with the subject: Cloud-Init CLA
+
+   You also may contanct user ``powersj`` in ``#cloud-init`` channel via IRC freenode.
 
 * Configure git with your email and name for commit messages.
 
@@ -24,26 +46,24 @@ Do these things once
     git config user.name "Your Name"
     git config user.email "Your Email"
 
-* Clone the upstream `repository`_ on Launchpad::
+* Sign into your `GitHub`_ account
 
-    git clone https://git.launchpad.net/cloud-init
-    cd cloud-init
-
-  There is more information on Launchpad as a git hosting site in
-  `Launchpad git documentation`_.
+* Fork the upstream `repository`_ on Github and clicking on the ``Fork`` button
 
-* Create a new remote pointing to your personal Launchpad repository.
-  This is equivalent to 'fork' on github.
+* Create a new remote pointing to your personal GitHub repository.
 
   .. code:: sh
 
-    git remote add LP_USER ssh://[e-mail]/~LP_USER/cloud-init
-    git push LP_USER master
+    git clone git://github.com/canonical/cloud-init
+    cd cloud-init
+    git remote add GH_USER [e-mail]:GH_USER/cloud-init.git
+    git push GH_USER master
 
-.. _repository: https://git.launchpad.net/cloud-init
+.. _GitHub: https://github.com
+.. _Launchpad: https://launchpad.net
+.. _repository: https://github.com/canonical/cloud-init
 .. _contributor license agreement: http://www.canonical.com/contributors
 .. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members
-.. _Launchpad git documentation: https://help.launchpad.net/Code/Git
 
 Do these things for each feature or bug
 =======================================
@@ -61,29 +81,21 @@ Do these things for each feature or bug
 
     tox
 
-* Push your changes to your personal Launchpad repository::
+* Push your changes to your personal GitHub repository::
 
-    git push -u LP_USER my-topic-branch
+    git push -u GH_USER my-topic-branch
 
 * Use your browser to create a merge request:
 
-  - Open the branch on Launchpad.
+  - Open the branch on GitHub
 
     - You can see a web view of your repository and navigate to the branch at:
 
-      ``https://code.launchpad.net/~LP_USER/cloud-init/``
-
-    - It will typically be at:
-
-      ``https://code.launchpad.net/~LP_USER/cloud-init/+git/cloud-init/+ref/BRANCHNAME``
-
-      for example, here is larsks move-to-git branch: https://code.launchpad.net/~larsks/cloud-init/+git/cloud-init/+ref/feature/move-to-git
+      ``https://github.com/GH_USER/cloud-init/tree/my-topic-branch``
 
-  - Click 'Propose for merging'
-  - Select 'lp:cloud-init' as the target repository
-  - Type '``master``' as the Target reference path
-  - Click 'Propose Merge'
-  - On the next page, hit 'Set commit message' and type a git combined git style commit message like::
+  - Click 'Pull Request`
+  - Fill out the pull request title, summarizing the change and a longer
+    message indicating important details about the changes included, like ::
 
       Activate the frobnicator.
 
@@ -100,12 +112,16 @@ Do these things for each feature or bug
 
       LP: #1
 
-Then, someone in the `cloud-init-dev`_ group will review your changes and
-follow up in the merge request.
+    Note that the project continues to use LP: #NNNNN format for closing
+    launchpad bugs rather than GitHub Issues.
+
+  - Click 'Create Pull Request`
+
+Then, someone in the `Ubuntu Server`_ team will review your changes and
+follow up in the pull request.
 
 Feel free to ping and/or join ``#cloud-init`` on freenode irc if you
 have any questions.
 
 .. _tox: https://tox.readthedocs.io/en/latest/
-.. _Launchpad: https://launchpad.net
-.. _cloud-init-dev: https://launchpad.net/~cloud-init-dev/+members#active
+.. _Ubuntu Server: https://github.com/orgs/canonical/teams/ubuntu-server
diff --git a/doc/rtd/topics/tests.rst b/doc/rtd/topics/tests.rst
index b83bd89..a2c703a 100644
--- a/doc/rtd/topics/tests.rst
+++ b/doc/rtd/topics/tests.rst
@@ -23,7 +23,7 @@ configuration users can run the integration tests via tox:
 
 .. code-block:: shell-session
 
-    $ git clone https://git.launchpad.net/cloud-init
+    $ git clone https://github.com/canonical/cloud-init
     $ cd cloud-init
     $ tox -e citest -- -h
 
@@ -53,7 +53,7 @@ explaining how to run one or the other independently.
 
 .. code-block:: shell-session
 
-    $ git clone https://git.launchpad.net/cloud-init
+    $ git clone https://github.com/canonical/cloud-init
     $ cd cloud-init
     $ tox -e citest -- run --verbose \
         --os-name stretch --os-name xenial \