Skip to content

Commit 1a47739

Browse files
authored
Update terms (#209)
* update terms access key -> API key editor token -> session token * update terms access key -> API key * remove extra space
1 parent d8960ac commit 1a47739

11 files changed

Lines changed: 23 additions & 23 deletions

File tree

website/docs/how-to/customize-plugins/plugin-editor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The editor is hosted at `https://editor.suborbital.network`, and uses URL parame
1414
You will host the SE2 builder service in your cloud infrastructure with a configured DNS name. An HTTPS connection to the builder is required to use the editor.
1515
To launch the editor, you can either [embed the editor in a frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) within your own webpage, or launch it in a new tab.
1616

17-
## Editor token
17+
## Session token
1818

19-
To authenticate the editor you'll need an [editor token](../../quickstart#obtain-an-editor-token).
19+
To authenticate the editor you'll need an [session token](../../quickstart#obtain-a-session-token).
2020

2121
## Configuration
2222

@@ -32,7 +32,7 @@ Let's break it down:
3232

3333
**Token**: `&token=K78as0aslwi30l8h5lbF4lS7`
3434

35-
* The editor token retrieved from the control-plane service
35+
* The session token retrieved from the control-plane service
3636

3737
**Ident**: `&ident=com.suborbital.customer`
3838

website/docs/how-to/self-host-se2/deploy/other-deployments/minikube.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Let’s tell minikube to forward requests to port 80 to our cluster!
172172
minikube tunnel
173173
```
174174

175-
### 8. Create an editor token
175+
### 8. Create a session token
176176

177177
In order to test our editor, we’re going to come up with a plugin name, and create a token so we can access it!
178178

@@ -206,7 +206,7 @@ Let’s install `curl`:
206206
apt update; apt install curl
207207
```
208208

209-
With `curl` installed, we can now get our editor token for testing:
209+
With `curl` installed, we can now get our session token for testing:
210210

211211
```bash
212212
curl [http://local.suborbital.network:8081/api/v1/token/<IDENT>/default/](http://local.suborbital.network:8081/api/v1/token/com.acmeco.gr9fas97234b/default/httpget)<PLUGIN_NAME>

website/docs/how-to/self-host-se2/self-hosted-quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,9 @@ The `local.suborbital.network` subdomain points to `127.0.0.1`, i.e. `localhost`
126126

127127
The SE2 plugin editor uses SE2's APIs from either [Go](./how-to/se2-go.md) or [JavaScript/TypeScript](./how-to/se2-js.md) to provide a low-friction environment for your users to write, build, test, and deploy plugins to your SE2 an instance in a single place. Alternatively, the [Builder API](https://reference.suborbital.dev/) can be used programmatically, if that better suits your use case.
128128

129-
### Obtain an editor token
129+
### Obtain a session token
130130

131-
In addition to the `IDENTIFIER` and `ENV_TOKEN`, you’ll also need to set `NAMESPACE` and `fn` to the name of our namespace (e.g. `default`) and the name of our plugin (e.g. `hello`). Copy the `token` field in the response; this is your editor token.
131+
In addition to the `IDENTIFIER` and `ENV_TOKEN`, you’ll also need to set `NAMESPACE` and `fn` to the name of our namespace (e.g. `default`) and the name of our plugin (e.g. `hello`). Copy the `token` field in the response; this is your session token.
132132

133133
```bash
134134
curl --location --request GET "http://local.suborbital.network:8082/auth/v2/access/${IDENTIFIER}/${NAMESPACE}/${EXT}" \

website/docs/quickstart-with-demo.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,33 +55,33 @@ Here we can see a counter for plugin builds and build minutes. Both of these are
5555

5656
![Environment dashboard screen showing zero function builds and zero build minutes](../../website/static/img/env-dashboard-screen.png)
5757

58-
## Create an access key
58+
## Create an API key
5959

60-
Next, we'll need to create an access key. We'll click on:
60+
Next, we'll need to create an API key. We'll click on:
6161

62-
- Manage access keys
63-
- Create new access key
62+
- Manage API keys
63+
- Create new API key
6464

65-
Our integration will use this access key to provision resources and execute plugins in SE2. We'll give our access key:
65+
Our integration will use this API key to provision resources and execute plugins in SE2. We'll give our API key:
6666

6767
- The name `DemoKey`
68-
- The description: `demo access key`
68+
- The description: `demo API key`
6969

70-
![Access key creation screen with fields for name and description](../../website/static/img/create-access-key-screen.png)
70+
![API key creation screen with fields for name and description](../../website/static/img/create-access-key-screen.png)
7171

7272
:::tip
73-
We'll only be shown this access key once, so we'll need to store it somewhere safe and secure!
73+
We'll only be shown this API key once, so we'll need to store it somewhere safe and secure!
7474
:::
7575

7676
## Integrate SE2 with our app
7777

78-
We'll need to supply our environment variables (our environment access key and the name of our environment) to SE2. Within the directory we created when we cloned the repo for this demo in the [preliminary steps](#preliminary-steps), we'll:
78+
We'll need to supply our environment variables (our environment API key and the name of our environment) to SE2. Within the directory we created when we cloned the repo for this demo in the [preliminary steps](#preliminary-steps), we'll:
7979

8080
- Open the `demo-proxyz` directory
8181
- Create a file named `.env`
8282
- Within our new `.env` file, we'll add our environment variables:
8383

84-
- `SUBORBITAL_TOKEN` is our environment's access key
84+
- `SUBORBITAL_TOKEN` is our environment's API key
8585
- `SUBORBITAL_ENV` is the name we gave our environment
8686

8787
- Next we'll need to export those variables by running:
@@ -106,9 +106,9 @@ Suborbital lets an application's users create their own secure, sandboxed plugin
106106

107107
The SE2 plugin editor uses SE2's APIs from either [Go](./how-to/se2-go.md) or [JavaScript/TypeScript](./how-to/se2-js.md) to provide a low-friction environment for your users to write, build, test, and deploy plugins to your SE2 an instance in a single place. Alternatively, the [Builder API](https://reference.suborbital.dev/) can be used programmatically, if that better suits your use case.
108108

109-
### Obtain an editor token
109+
### Obtain a session token
110110

111-
In addition to the `IDENTIFIER` and `ENV_TOKEN`, you’ll also need to set `NAMESPACE` and `fn` to the name of our namespace (e.g. `default`) and the name of our plugin (e.g. `hello`). Copy the `token` field in the response; this is your editor token.
111+
In addition to the `IDENTIFIER` and `ENV_TOKEN`, you’ll also need to set `NAMESPACE` and `fn` to the name of our namespace (e.g. `default`) and the name of our plugin (e.g. `hello`). Copy the `token` field in the response; this is your session token.
112112

113113
```bash
114114
curl --location --request GET "http://local.suborbital.network:8082/auth/v2/access/${IDENTIFIER}/${NAMESPACE}/${EXT}" \

website/docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Our integration will use this API key to provision resources and execute plugins
5959
- The name `DemoKey`
6060
- The description: `demo API key`
6161

62-
![API key creation screen with fields for name and description](../../website/static/img/create-access-key-screen.png)
62+
![API key creation screen with fields for name and description](../../website/static/img/create-api-key-screen.png)
6363

6464
:::tip
6565
We'll only be shown this API key once, so we'll need to store it somewhere safe and secure!
@@ -188,7 +188,7 @@ The SE2 plugin editor uses SE2's APIs from either [Go](./how-to/se2-go.md) or [J
188188

189189
To grant a user access to modify a plugin, you'll need a session token. A session token is bound to a single plugin, and you'll create new tokens each time a user needs access to a plugin. To obtain a session token:
190190

191-
<Tabs groupId='editor-token'>
191+
<Tabs groupId='session-token'>
192192

193193
<TabItem value="go" label="Using Go">
194194
Call the `CreateSession` method with your tenant's name, the namespace, and the plugin name of your intended plugin. The response will be a struct that contains the session token. All tenant API methods will use this session response struct as input.

website/docs/reference/future-glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ pagination_next: null
1414
| Tenant | words | Identifies the relationship between an Environment and some specific user or collection of users interacting with it. The Environment administrator manages and identifies this relationship including, but not limited to, tenant authentication. | tnt |
1515
| Client | words | The application communicating with SE2 on the behalf of some Tenant | |
1616
| Environment Token | words | Grants a Client access to an environment | |
17-
| Editor Token | words | Grants a Tenant access to the Builder Service | |
17+
| Session Token | words | Grants a Tenant access to the Builder Service | |

website/docs/reference/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ pagination_next: null
1212
| Tenant | Identifies the relationship between an Environment and some specific user or collection of users interacting with it. The Environment administrator manages and identifies this relationship including, but not limited to, tenant authentication. | tnt |
1313
| Client | The application communicating with SE2 on the behalf of some Tenant | |
1414
| Environment Token | Grants a Client access to an environment | |
15-
| Editor Token | Grants a Tenant access to the Builder Service | |
15+
| Session Token | Grants a Tenant access to the Builder Service | |
46.5 KB
Loading
-2.79 KB
Loading
-2.45 KB
Loading

0 commit comments

Comments
 (0)