about summary refs log tree commit diff
diff options
context:
space:
mode:
authortoastal <toastal@posteo.net>2024-06-15T16·37+0700
committertoastal <toastal@posteo.net>2024-06-15T17·42+0000
commitc2a9ad35830056dcaf6a0e1726dcc4dc094cf962 (patch)
tree9b763122e39a1b3d5a3b243803afa95d2bd926ca
parent01aadace80108e32322ea64a7ca355a1cb04d3d9 (diff)
docs: move Registration to the top; minor reword r/8281
When trying to follow Review documentation, I got tripped up on the
“Gerrit setup” section that was asking about SSH keys since I hadn’t yet
gotten an account setup but the registration setion was near the bottom
of the document despite being a requirement for setting up Gerrit.

Included words specifying SSO, specifies that the TVL account is an
alternative method, & commit→patch since you send a patch with the
commit.

Change-Id: I465c8a79979b368ab01bcebdc7e5ef16e65dd341
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11823
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
-rw-r--r--docs/REVIEWS.md41
1 files changed, 24 insertions, 17 deletions
diff --git a/docs/REVIEWS.md b/docs/REVIEWS.md
index d76f11f41074..9d2356744d12 100644
--- a/docs/REVIEWS.md
+++ b/docs/REVIEWS.md
@@ -5,10 +5,10 @@ TVL Code Reviews
 **Table of Contents**
 
 - [TVL Code Reviews](#tvl-code-reviews)
+    - [Registration](#registration)
     - [Gerrit setup](#gerrit-setup)
     - [Gerrit workflows](#gerrit-workflows)
     - [Review process & approvals](#review-process--approvals)
-    - [Registration](#registration)
     - [Submitting changes via email](#submitting-changes-via-email)
     - [Gerrit for Github users](#gerrit-for-github-users)
 
@@ -22,6 +22,28 @@ contribution guidelines](./CONTRIBUTING.md).
 All changes are tracked at [cl.tvl.fyi](https://cl.tvl.fyi) using Gerrit. See
 [Registration](#registration) for information on how to register an account.
 
+## Registration
+
+The preferred method of contributions & review is done via Gerrit.
+
+TVL’s Gerrit supports single sign-on (SSO) using a GitHub, StackOverflow or
+GitLab.com account.
+
+Additionally if you want prefer not to use an SSO option or wish to have a
+backup authentication strategy in the event of downed server or a keycloak
+issue (recommended), you can create a TVL-specific LDAP account on the Gerrit
+instance by following these instructions:
+
+1. Be a member of `#tvl` on [hackint][].
+2. Clone the depot locally (via `git clone "https://cl.tvl.fyi/depot"`).
+3. Create a user entry in our LDAP server in [ops/users][ops-users].
+
+   The entry can be generated using [//web/pwcrypt](https://signup.tvl.fyi/).
+4. Create a commit adding yourself (see e.g.
+   [CL/2671](https://cl.tvl.fyi/c/depot/+/2671))
+5. If only using LDAP, submit the patch via email (see
+   [Submitting changes via email](#submitting-changes-via-email))
+
 ## Gerrit setup
 
 Gerrit uses the concept of change IDs to track commits across rebases and other
@@ -111,23 +133,8 @@ formalised checks before submitting:
 If all these conditions are fulfilled, the **change author submits their change
 themselves**.
 
-## Registration
-
-You may log into Gerrit using a GitHub, StackOverflow or GitLab.com account.
-
-If you would like to have a TVL-specific account on the Gerrit
-instance, follow these instructions:
-
-1. Be a member of `#tvl` on [hackint][].
-2. Clone the depot locally (via `git clone "https://cl.tvl.fyi/depot"`).
-3. Create a user entry in our LDAP server in [ops/users][ops-users].
-
-   The entry can be generated using [//web/pwcrypt](https://signup.tvl.fyi/).
-4. Create a commit adding yourself (see e.g.
-   [CL/2671](https://cl.tvl.fyi/c/depot/+/2671))
-5. Submit the commit via email (see below).
-
 ## Submitting changes via email
+
 Please keep in mind this process is more complicated and requires more work from
 both sides: