Merge pull request #947 from ethereum/flamingo

Deployment & Flamingo Doc Updates

book/src/SUMMARY.md

@@ -55,9 +55,8 @@
             - [Linux](developers/contributing/build_instructions/linux.md)
             - [Raspberry Pi](developers/contributing/build_instructions/raspberry_pi.md)
             - [Windows](developers/contributing/build_instructions/windows.md)
-        - [Releases](developers/contributing/releases/README.md)
-            - [Pre-release checklist](developers/contributing/releases/prerelease_checklist.md)
-            - [Release checklist](developers/contributing/releases/release_checklist.md)
+        - [Release & Deployment](developers/contributing/releases/README.md)
+            - [Release](developers/contributing/releases/release_checklist.md)
             - [Deployment](developers/contributing/releases/deployment.md)
         - [Tests](developers/contributing/tests.md)
         - [Book](developers/contributing/book.md)

book/src/developers/contributing/releases/README.md

@@ -1,3 +1,3 @@
 # Releases
 
-This section covers the process of making a Trin release.
+This section covers the process of making & deploying a Trin release.

book/src/developers/contributing/releases/deployment.md

@@ -2,15 +2,17 @@
 
 ## First time Setup
 - Get access to cluster repo (add person to @trin-deployments)
-- Download cluster repo:
-```shell=
-git clone [email protected]:ethereum/cluster.git
-cd cluster
-python3 -m venv venv
-. venv/bin/activate
-pip install ansible
-sudo apt install ansible-core
-```
+- `git clone` the cluster repo: https://github.com/ethereum/cluster.git
+- Install dependencies within `cluster` virtualenv:
+    ```shell=
+    cd cluster
+    python3 -m venv venv
+    . venv/bin/activate
+    pip install ansible
+    sudo apt install ansible-core
+    ```
+    On mac you can do `brew install ansible` instead of `apt`.
+
 - [Install keybase](https://keybase.io/docs/the_app/install_linux)
 - Publish your pgp public key with keybase, using: `keybase pgp select --import`
   - This fails if you don't have a pgp key yet. If so, create one with `gpg --generate-key`
@@ -26,6 +28,7 @@ sudo apt install ansible-core
 ## Each Deployment
 
 ### Prepare
+- Generally we want to cut a new release before deployment, see previous page for instructions.
 - Announce in Discord #trin that you're about to run the deployment
 - Make sure to schedule plenty of time to react to deployment issues
 
@@ -117,6 +120,8 @@ but none were.
 ```
 It means your key isn't working. Check with `@paulj`.
 
+If using `gpg` and decryption problems persist, see [this potential fix](https://github.com/getsops/sops/issues/304#issuecomment-377195341).
+
 ### What do I do if Ansible says a node is unreachable?
 You might see this during a deployment:
 > fatal: [trin-ams3-18]: UNREACHABLE! => {"changed": false, "msg": "Failed to connect to the host via ssh: ssh: connect to host 178.128.253.26 port 22: Connection timed out", "unreachable": true}

book/src/developers/contributing/releases/release_checklist.md

@@ -1,5 +1,11 @@
 # Release checklist
 
+## Communicate
+
+Announce in #trin chat the upcoming release. Aim for a day or more notice, but
+announcing a few minutes before releasing is still better than not saying
+anything.
+
 ## Choosing a version
 
 Make sure that version follows [semver](https://semver.org/) rules e.g (`0.2.0-alpha.3`).
@@ -9,9 +15,10 @@ Make sure that version follows [semver](https://semver.org/) rules e.g (`0.2.0-a
 ## Bump the version
 
 - In github, open the page to [create the new release](https://github.com/ethereum/trin/releases/new).
-- In the tag, type out the version number that the new release bumps to.
+- In the tag, type out the version number that the new release bumps to and select "Create new tag".
 - Github should say "Excellent! This tag will be created from the target when you publish this release."
 - Click "Generate release notes"
+- Select "Set as a pre-release"
 - Add "Trin " to the beginning of the release title
 - Add any clarifying information that's helpful about the release
 
@@ -37,16 +44,6 @@ We no longer use `make release` because it's not worth the effort to release all
 * [Raspberry Pi](../build_instructions/raspberry_pi.md)
 * [Windows](../build_instructions/windows.md)
 
-## Create github release page
-
-Go to [trin tags](https://github.com/ethereum/trin/tags).
-
-Find the tag you pushed, and in the `...` menu, select [Create release]
-
-Write up a high-level overview, and link to the generated release notes.
-
-Attach the generated binaries.
-
 ## Deploy
 
 Push these changes out to the nodes we run in the network. See next page for details.

book/src/developers/contributing/rotation/index.md

@@ -30,6 +30,10 @@ Read through the notes, and then generate the new checklist for the week, by [cr
 
 Link the generated checklist into the Flamingo notes for your week. Make sure your status is "online" in Discord. Make sure you're tagged under the `trin-flamingo` role. Put on your favorite pink shirt. Watch a [silly flamingo video](https://www.youtube.com/watch?v=gWNWtbPEWw0). Fly.
 
+### First
+
+Read through the "Setup" section of the [Deployment Instructions](../releases/deployment.md) and follow the steps to make sure that your PGP and SSH keys are in place and ready for a deployment. 
+
 ### Daily
 
 #### Checklist