diff --git a/doc/source/admin/examples/docker-compose.yaml b/doc/source/admin/examples/docker-compose.yaml index 6015fec8c1..67c429c76a 100644 --- a/doc/source/admin/examples/docker-compose.yaml +++ b/doc/source/admin/examples/docker-compose.yaml @@ -8,6 +8,13 @@ services: ports: - "8080:8080" - "29418:29418" + command: | + /bin/sh -c '\ + git config -f /var/gerrit/etc/gerrit.config gerrit.canonicalWebUrl http://localhost:8080/ && \ + git config -f /var/gerrit/etc/gerrit.config gerrit.ui POLYGERRIT && \ + git config -f /var/gerrit/etc/gerrit.config sendemail.enable false && \ + git config -f /var/gerrit/etc/gerrit.config noteDb.changes.autoMigrate true && \ + /var/gerrit/bin/gerrit.sh run' gerritconfig: image: zuul/zuul environment: diff --git a/doc/source/admin/images/become.png b/doc/source/admin/images/become.png deleted file mode 100644 index b3becb0e4c..0000000000 Binary files a/doc/source/admin/images/become.png and /dev/null differ diff --git a/doc/source/admin/images/check1-1002.png b/doc/source/admin/images/check1-1002.png index 7078eb931f..081e420fbc 100644 Binary files a/doc/source/admin/images/check1-1002.png and b/doc/source/admin/images/check1-1002.png differ diff --git a/doc/source/admin/images/check2-1002.png b/doc/source/admin/images/check2-1002.png index f38dd65397..73930467e5 100644 Binary files a/doc/source/admin/images/check2-1002.png and b/doc/source/admin/images/check2-1002.png differ diff --git a/doc/source/admin/images/confirm.png b/doc/source/admin/images/confirm.png new file mode 100644 index 0000000000..71f86c0511 Binary files /dev/null and b/doc/source/admin/images/confirm.png differ diff --git a/doc/source/admin/images/continue.png b/doc/source/admin/images/continue.png deleted file mode 100644 index 17c7a6dd45..0000000000 Binary files a/doc/source/admin/images/continue.png and /dev/null differ diff --git a/doc/source/admin/images/email.png b/doc/source/admin/images/email.png new file mode 100644 index 0000000000..4be4ac0690 Binary files /dev/null and b/doc/source/admin/images/email.png differ diff --git a/doc/source/admin/images/name.png b/doc/source/admin/images/name.png deleted file mode 100644 index 0a9794d473..0000000000 Binary files a/doc/source/admin/images/name.png and /dev/null differ diff --git a/doc/source/admin/images/open-changes.png b/doc/source/admin/images/open-changes.png index 0a3da3f314..43e5375436 100644 Binary files a/doc/source/admin/images/open-changes.png and b/doc/source/admin/images/open-changes.png differ diff --git a/doc/source/admin/images/orig/become.png b/doc/source/admin/images/orig/become.png deleted file mode 100644 index 2f22bb4c65..0000000000 Binary files a/doc/source/admin/images/orig/become.png and /dev/null differ diff --git a/doc/source/admin/images/orig/check1-1002.png b/doc/source/admin/images/orig/check1-1002.png index f01b1372fe..02d2a954f3 100644 Binary files a/doc/source/admin/images/orig/check1-1002.png and b/doc/source/admin/images/orig/check1-1002.png differ diff --git a/doc/source/admin/images/orig/check2-1002.png b/doc/source/admin/images/orig/check2-1002.png index acd84a1ca1..f22313f907 100644 Binary files a/doc/source/admin/images/orig/check2-1002.png and b/doc/source/admin/images/orig/check2-1002.png differ diff --git a/doc/source/admin/images/orig/confirm.png b/doc/source/admin/images/orig/confirm.png new file mode 100644 index 0000000000..e963d221e4 Binary files /dev/null and b/doc/source/admin/images/orig/confirm.png differ diff --git a/doc/source/admin/images/orig/continue.png b/doc/source/admin/images/orig/continue.png deleted file mode 100644 index c4a621fe14..0000000000 Binary files a/doc/source/admin/images/orig/continue.png and /dev/null differ diff --git a/doc/source/admin/images/orig/name.png b/doc/source/admin/images/orig/name.png deleted file mode 100644 index dbd200fd12..0000000000 Binary files a/doc/source/admin/images/orig/name.png and /dev/null differ diff --git a/doc/source/admin/images/orig/open-changes.png b/doc/source/admin/images/orig/open-changes.png index 6733bee05e..7955356882 100644 Binary files a/doc/source/admin/images/orig/open-changes.png and b/doc/source/admin/images/orig/open-changes.png differ diff --git a/doc/source/admin/images/orig/recheck-1002.png b/doc/source/admin/images/orig/recheck-1002.png index 8b55bbd69b..bda8021aba 100644 Binary files a/doc/source/admin/images/orig/recheck-1002.png and b/doc/source/admin/images/orig/recheck-1002.png differ diff --git a/doc/source/admin/images/orig/review-1001.png b/doc/source/admin/images/orig/review-1001.png index 477040e25e..9986699c76 100644 Binary files a/doc/source/admin/images/orig/review-1001.png and b/doc/source/admin/images/orig/review-1001.png differ diff --git a/doc/source/admin/images/orig/review-1003.png b/doc/source/admin/images/orig/review-1003.png index f109ec6a1e..b45b5e611a 100644 Binary files a/doc/source/admin/images/orig/review-1003.png and b/doc/source/admin/images/orig/review-1003.png differ diff --git a/doc/source/admin/images/orig/settings.png b/doc/source/admin/images/orig/settings.png new file mode 100644 index 0000000000..0eda21d5c8 Binary files /dev/null and b/doc/source/admin/images/orig/settings.png differ diff --git a/doc/source/admin/images/orig/sign-in.png b/doc/source/admin/images/orig/sign-in.png new file mode 100644 index 0000000000..278f22fc38 Binary files /dev/null and b/doc/source/admin/images/orig/sign-in.png differ diff --git a/doc/source/admin/images/orig/sign-out-admin.png b/doc/source/admin/images/orig/sign-out-admin.png new file mode 100644 index 0000000000..071f8e3f3d Binary files /dev/null and b/doc/source/admin/images/orig/sign-out-admin.png differ diff --git a/doc/source/admin/images/orig/sign-out-user.png b/doc/source/admin/images/orig/sign-out-user.png new file mode 100644 index 0000000000..e8642bfc9a Binary files /dev/null and b/doc/source/admin/images/orig/sign-out-user.png differ diff --git a/doc/source/admin/images/orig/sshkey.png b/doc/source/admin/images/orig/sshkey.png deleted file mode 100644 index 119d69e368..0000000000 Binary files a/doc/source/admin/images/orig/sshkey.png and /dev/null differ diff --git a/doc/source/admin/images/orig/submit-1001.png b/doc/source/admin/images/orig/submit-1001.png index c29d795949..495ff51b8e 100644 Binary files a/doc/source/admin/images/orig/submit-1001.png and b/doc/source/admin/images/orig/submit-1001.png differ diff --git a/doc/source/admin/images/orig/switch-admin.png b/doc/source/admin/images/orig/switch-admin.png deleted file mode 100644 index 56bf61558b..0000000000 Binary files a/doc/source/admin/images/orig/switch-admin.png and /dev/null differ diff --git a/doc/source/admin/images/orig/switch-example.png b/doc/source/admin/images/orig/switch-example.png deleted file mode 100644 index b76e235d7c..0000000000 Binary files a/doc/source/admin/images/orig/switch-example.png and /dev/null differ diff --git a/doc/source/admin/images/orig/username.png b/doc/source/admin/images/orig/username.png deleted file mode 100644 index c5ea02691f..0000000000 Binary files a/doc/source/admin/images/orig/username.png and /dev/null differ diff --git a/doc/source/admin/images/profile.png b/doc/source/admin/images/profile.png new file mode 100644 index 0000000000..d07b577937 Binary files /dev/null and b/doc/source/admin/images/profile.png differ diff --git a/doc/source/admin/images/recheck-1002.png b/doc/source/admin/images/recheck-1002.png index f2fc6227d7..8b4c467531 100644 Binary files a/doc/source/admin/images/recheck-1002.png and b/doc/source/admin/images/recheck-1002.png differ diff --git a/doc/source/admin/images/review-1001.png b/doc/source/admin/images/review-1001.png index ecdf4deec6..c699b62833 100644 Binary files a/doc/source/admin/images/review-1001.png and b/doc/source/admin/images/review-1001.png differ diff --git a/doc/source/admin/images/review-1003.png b/doc/source/admin/images/review-1003.png index 8cfc37d074..b6bd003b0f 100644 Binary files a/doc/source/admin/images/review-1003.png and b/doc/source/admin/images/review-1003.png differ diff --git a/doc/source/admin/images/sign-in.png b/doc/source/admin/images/sign-in.png new file mode 100644 index 0000000000..2b361c41ff Binary files /dev/null and b/doc/source/admin/images/sign-in.png differ diff --git a/doc/source/admin/images/sign-out-admin.png b/doc/source/admin/images/sign-out-admin.png new file mode 100644 index 0000000000..f1ef6f9f10 Binary files /dev/null and b/doc/source/admin/images/sign-out-admin.png differ diff --git a/doc/source/admin/images/sign-out-user.png b/doc/source/admin/images/sign-out-user.png new file mode 100644 index 0000000000..a8cf859c1d Binary files /dev/null and b/doc/source/admin/images/sign-out-user.png differ diff --git a/doc/source/admin/images/sshkey.png b/doc/source/admin/images/sshkey.png index f4f8dfee9f..f8ed79fde0 100644 Binary files a/doc/source/admin/images/sshkey.png and b/doc/source/admin/images/sshkey.png differ diff --git a/doc/source/admin/images/submit-1001.png b/doc/source/admin/images/submit-1001.png index 046f703a98..34580b5736 100644 Binary files a/doc/source/admin/images/submit-1001.png and b/doc/source/admin/images/submit-1001.png differ diff --git a/doc/source/admin/images/switch-admin.png b/doc/source/admin/images/switch-admin.png deleted file mode 100644 index dbf4b8d141..0000000000 Binary files a/doc/source/admin/images/switch-admin.png and /dev/null differ diff --git a/doc/source/admin/images/switch-example.png b/doc/source/admin/images/switch-example.png deleted file mode 100644 index d43894edcc..0000000000 Binary files a/doc/source/admin/images/switch-example.png and /dev/null differ diff --git a/doc/source/admin/images/username.png b/doc/source/admin/images/username.png deleted file mode 100644 index ee10c7d0d9..0000000000 Binary files a/doc/source/admin/images/username.png and /dev/null differ diff --git a/doc/source/admin/quick-start.rst b/doc/source/admin/quick-start.rst index cfca938918..bcd779738b 100644 --- a/doc/source/admin/quick-start.rst +++ b/doc/source/admin/quick-start.rst @@ -96,9 +96,9 @@ required in the web interface and you may become any user in the system at any time. To create your Gerrit account, visit http://localhost:8080 in your -browser and click `Become`. +browser and click `Sign in` in the top right corner. -.. image:: images/become.png +.. image:: images/sign-in.png :align: center Then click `New Account` under `Register`. @@ -106,30 +106,44 @@ Then click `New Account` under `Register`. .. image:: images/register.png :align: center -Enter your full name and click `Save Changes`. +Don't bother to enter anything into the confirmation dialog that pops +up, instead, click the `settings` link at the bottom. -.. image:: images/name.png +.. image:: images/confirm.png :align: center -Enter the username you use to log into your workstation in the -`Username` field and click `Select Username`. +In the `Profile` section at the top, enter the username you use to log +into your workstation in the `Username` field and your full name in +the `Full name` field, then click `Save Changes`. -.. image:: images/username.png +.. image:: images/profile.png :align: center -Copy and paste the contents of ``~/.ssh/id_rsa.pub`` into the SSH key -field and click `Add`. +Scroll down to the `Email Addresses` section and enter your email +address into the `New email address` field, then click `Send +Verification`. Since Gerrit is in developer mode, it will not +actually send any email, and the address will be automatically +confirmed. This step is useful since several parts of the Gerrit user +interface expect to be able to display email addresses. + +.. image:: images/email.png + :align: center + +Scroll down to the `SSH keys` section and copy and paste the contents +of ``~/.ssh/id_rsa.pub`` into the `New SSH key` field and click `Add +New SSH Key`. .. image:: images/sshkey.png :align: center -Click the `Continue` link at the bottom of the page. +.. We ask them to click reload so that the page refreshes and their + avatar appears in the top right. Otherwise it's difficult to see + that there's anything there to click. -.. image:: images/continue.png - :align: center - -At this point you have created and logged into your personal account -in Gerrit and are ready to begin configuring Zuul. +Click the `Reload` button in your browser to reload the page with the +new settings in effect. At this point you have created and logged +into your personal account in Gerrit and are ready to begin +configuring Zuul. Configure Zuul Pipelines ------------------------ @@ -228,10 +242,14 @@ last time). To do this, you need to switch to the Administrator account in Gerrit. Visit http://localhost:8080 in your browser and then: -Click on your name in the top right corner then click `Switch -Account`. +Click the avatar image in the top right corner then click `Sign out`. -.. image:: images/switch-example.png +.. image:: images/sign-out-user.png + :align: center + +Then click the `Sign in` link again. + +.. image:: images/sign-in.png :align: center Click `admin` to log in as the `admin` user. @@ -239,8 +257,8 @@ Click `admin` to log in as the `admin` user. .. image:: images/become-select.png :align: center -In the top left corner of the page, click `All` and `Open` to see the -list of open changes, then click on the change you uploaded. +You will then see a list of open changes; click on the change you +uploaded. .. image:: images/open-changes.png :align: center @@ -250,13 +268,13 @@ open a dialog where you can leave a review message and vote on the change. As the administrator, you have access to vote in all of the review categories, even `Verified` which is normally reserved for Zuul. Vote Code-Review: +2, Verified: +2, Workflow: +1, and then -click `Post` to leave your approval votes. +click `Send` to leave your approval votes. .. image:: images/review-1001.png :align: center -Once the required votes have been set, the `Submit` button will -appear; click it. This will cause the change to be merged +Once the required votes have been set, the `Submit` button will appear +in the top right; click it. This will cause the change to be merged immediately. This is normally handled by Zuul, but as the administrator you can bypass Zuul to forcibly merge a change. @@ -265,13 +283,18 @@ administrator you can bypass Zuul to forcibly merge a change. Now that the initial configuration has been bootstrapped, you should not need to bypass testing and code review again, so switch back to -the account you created for yourself. Click on `Administrator` in the -top right corner then click `Switch Account`. +the account you created for yourself. Click on the avatar image in +the top right corner then click `Sign out`. -.. image:: images/switch-admin.png +.. image:: images/sign-out-admin.png :align: center -Click your username. +Then click the `Sign in` link again. + +.. image:: images/sign-in.png + :align: center + +And click your username to log into your account. .. image:: images/become-select.png :align: center @@ -325,7 +348,7 @@ Zuul will dynamically evaluate proposed changes to its configuration in *untrusted projects* immediately, so shortly after your change is uploaded, Zuul will run the new job and report back on the change. -Visit http://localhost:8080/#/dashboard/self and open the change you +Visit http://localhost:8080/dashboard/self and open the change you just uploaded. If the build is complete, Zuul should have left a Verified: +1 vote on the change, along with a comment at the bottom. Expand the comments and you should see that the job succeeded, but @@ -434,11 +457,11 @@ Then commit the change and upload it to Gerrit for review: git commit -m "Update Zuul base job" git review -Visit http://localhost:8080/#/dashboard/self and open the +Visit http://localhost:8080/dashboard/self and open the ``zuul-config`` change you just uploaded. You should see a Verified +1 vote from Zuul. Click `Reply` then vote -Code-Review: +2 and Workflow: +1 then click 'Post'. +Code-Review: +2 and Workflow: +1 then click `Send`. .. image:: images/review-1003.png :align: center @@ -446,9 +469,9 @@ Code-Review: +2 and Workflow: +1 then click 'Post'. Wait a few moments for Zuul to process the event, and then reload the page. The change should have been merged. -Visit http://localhost:8080/#/dashboard/self and return to the +Visit http://localhost:8080/dashboard/self and return to the ``test1`` change you uploaded earlier. Click `Reply` then type -`recheck` into the text field and click `Post`. +`recheck` into the text field and click `Send`. .. image:: images/recheck-1002.png :align: center