Fixing docs

2i2c-org · Nov 23, 2022 · ae068f6 · ae068f6
2 parents 42e3a65 + 2ba3b1c
commit ae068f6
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/about/distributions/index.md b/about/distributions/index.md
@@ -84,7 +84,7 @@ As members of the JupyterHub team, we are constantly looking for ways to improve
 2i2c will not collect user data for any purpose beyond what is required in order to run a JupyterHub.
 Depending on the choices of your community the hub might contain identifiable information (e.g., e-mail addresses used as usernames for authentication), but this will remain within your hub's configuration and is not shared publicly.
 
-Our {term}`Cloud Engineering Team` will have access to all of the information that is inside a hub (which it requires in order to debug problems and and assist with upgrades), however we will not retain any of this data or move it *outside* of the hub, and will not retain it once the hub is shut down (except in order to transfer data to you at your request).
+Our {role}`Site Reliability Engineer`s will have access to all of the information that is inside a hub (which it requires in order to debug problems and and assist with upgrades), however we will not retain any of this data or move it *outside* of the hub, and will not retain it once the hub is shut down (except in order to transfer data to you at your request).
 
 ## Monitored for abuse and unexpected costs
 

diff --git a/about/distributions/research.md b/about/distributions/research.md
@@ -10,6 +10,7 @@ This hub deployment is designed for researchers and teams that wish to do their
 
 Below is a diagram that showcases some of the major components of this hub:
 
+% automatically downloaded in conf.py
 ```{figure} /images/scalable_research_hub.png
 
 A high level overview of major components in a scalable computing hub.

diff --git a/support.md b/support.md
@@ -8,17 +8,15 @@ When you make a support request, please include as much information as possible
 % hard-coding this because sphinx-design buttons don't work with mailto
 <a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary reference external" href="mailto:[email protected]"><span>Send a support email</span></a>
 
-## Types of support
-
-For information about the types of support we may offer, and how it relates to our Shared Responsibility Model, see [](shared-responsibility:support).
-
 ## Who can ask for support?
 
-A **Community Representative** of a hub should be the one that surfaces support requests to the 2i2c Engineering Team.
+A {role}`Community Representative` of a hub should be the one that surfaces support requests to the 2i2c {role}`Site Reliability Engineer`ing team.
 Before reaching out to 2i2c for support, this person should work with others in their community to understand the problem and to ensure that it is something that requires intervention from a 2i2c Engineer.
 
 ## The support process
 
+You can find our {external:tc:ref}`full support process in our Team Compass <support:guide>`. Below is a brief overview.
+
 When you send us a support email, we'll try and resolve your issue via the following process:
 
 - The email to `[email protected]` will open up a ticket in [the 2i2c FreshDesk account](https://2i2c.freshdesk.com).
@@ -30,7 +28,7 @@ When you send us a support email, we'll try and resolve your issue via the follo
 - Throughout this process, we'll communicate with you via the `[email protected]` address. You are also  welcome to follow along and discuss in any issues that we may create if you prefer.
 - When the issue is resolved, we'll send you a confirmation via `[email protected]`, and we'll close the support issue.
 
-## Send encrypted content
+## Send us encrypted content
 
 Sometimes community representatives need to send us *encrypted* information -
 usually credentials for cloud access or an authentication system. We use
@@ -49,6 +47,14 @@ This page describes how you can encrypt information and send it to us!
 2. Run `age -e -r age1mmx8hfzalmn3tmpryrfvcud5vyfakxdfqe683r40qkr6pjd2ag6s72cat5 -a` on
    your terminal, and paste the contents of the message you want to encrypt. Press enter,
    then `Ctrl-D`. Make sure to copy this exactly!
+
+   ```{note}
+   The parameter passed to `-r` (ag1mmx....) is the public key used to *encrypt* the message,
+   which we can decrypt with our private key. Providing it as part of the command makes it
+   easier to distribute the public key, as otherwise users would have to download and manage
+   a public key file.
+   ```
+
 3. `age` will print the encrypted version of your message on your terminal, and it'll look
    something like this: