Skip to content

Commit b2045d4

Browse files
mendonkaimurphy
andauthored
docs: update quickstart (#147)
* update-quickstart * icon * update-language-on-websocket-page * update-language-for-finding-streaming-tenants * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * typo --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
1 parent 9d75b98 commit b2045d4

12 files changed

Lines changed: 26 additions & 29 deletions

modules/developing/pages/astream-functions.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ See <<controlling-your-function,Controlling your function>> for more information
287287

288288
== Deploy functions in the {astra-ui}
289289

290-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
290+
. In the {astra-ui-link}, click *Streaming tenants*.
291291

292292
. Click the name of the tenant where you want to deploy a function.
293293

@@ -393,7 +393,7 @@ Your function should output the result of processing the message.
393393
[#controlling-your-function]
394394
=== Stop and start functions
395395

396-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
396+
. In the {astra-ui-link}, click *Streaming tenants*.
397397

398398
. Click the name of the tenant where you want to manage functions, and then click the *Functions* tab.
399399

@@ -403,7 +403,7 @@ Your function should output the result of processing the message.
403403

404404
Functions produce logs to help you debug them.
405405

406-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
406+
. In the {astra-ui-link}, click *Streaming tenants*.
407407

408408
. Click the name of the tenant that you want to debug, and then click the *Functions* tab.
409409

@@ -415,7 +415,7 @@ If you specified a log topic when deploying your function, function logs also ou
415415

416416
=== Edit functions
417417

418-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
418+
. In the {astra-ui-link}, click *Streaming tenants*.
419419

420420
. Click the name of the tenant where your function is deployed, and then click the *Functions* tab.
421421

@@ -436,7 +436,7 @@ If you need to change any other function settings, you must delete and redeploy
436436
Deleting a function is permanent.
437437
====
438438

439-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
439+
. In the {astra-ui-link}, click *Streaming tenants*.
440440

441441
. Click the name of the tenant where you want to delete a function, and then click the *Functions* tab.
442442

modules/developing/pages/clients/spring-produce-consume.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ Message received: Hello World
176176
----
177177
====
178178

179-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
179+
. In the {astra-ui-link}, click *Streaming tenants*.
180180

181181
. Click the name of your tenant, and then verify that the message appears in the specified namespace and topic.
182182

modules/developing/pages/configure-pulsar-env.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The executables in `/bin` use the configurations in `/conf` to run commands.
4444
Each tenant you create in {product} comes with its own custom configuration for SSO, endpoints, and so on.
4545
You must download the tenant configuration from {product}, and then overwrite the `./conf/client.conf` file.
4646

47-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
47+
. In the {astra-ui-link}, click *Streaming tenants*.
4848

4949
. Click the name of your tenant.
5050

modules/developing/pages/gpt-schema-translator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The {gpt-schema-translator} is available for the {astra-db} sink connector only.
2323
This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table.
2424
The {gpt-schema-translator} generates a mapping between the two schemas that the {astra-db} sink connector can use to write data from the {pulsar-short} topic to the {astra-db} table.
2525

26-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
26+
. In the {astra-ui-link}, click *Streaming tenants*.
2727

2828
. Click the name of your tenant.
2929

modules/developing/pages/produce-consume-astra-portal.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The following steps will use the "Try Me" feature of the {astra-ui} to interact
99

1010
== Select the producer and consumer topics
1111

12-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
12+
. In the {astra-ui-link}, click *Streaming tenants*.
1313

1414
. Click the name of your tenant.
1515

modules/developing/pages/using-curl.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Depending on the API you use, you need certain information to form HTTP requests
1212
1313
== Get the tenant web service URL
1414

15-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
15+
. In the {astra-ui-link}, click *Streaming tenants*.
1616

1717
. Click the name of your tenant.
1818

modules/developing/partials/client-variables-table.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
|`serviceUrl`
66
|The URL to connect to the {pulsar-short} cluster
77
a|
8-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
8+
. In the {astra-ui-link}, click *Streaming tenants*.
99
. Click the name of your tenant, and then click the *Connect* tab.
1010
. In the *Tenant Details* section, get the *Broker Service URL*.
1111

@@ -16,20 +16,20 @@ a|
1616
|`tenantName`
1717
|The name of your streaming tenant
1818
a|
19-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
20-
. Get the name from the *Tenants* list.
19+
. In the {astra-ui-link}, click *Streaming tenants*.
20+
. Get the name from the list of tenants.
2121

2222
|`namespace`
2323
|The segmented area for certain topics in your streaming tenant
2424
a|
25-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
25+
. In the {astra-ui-link}, click *Streaming tenants*.
2626
. Click the name of your tenant, and then click the *Namespace and Topics* tab.
2727
. Choose the target namespace from the list of namespaces.
2828

2929
|`topicName`
3030
|Topic name (not the full name)
3131
a|
32-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
32+
. In the {astra-ui-link}, click *Streaming tenants*.
3333
. Click the name of your tenant, and then click the *Namespace and Topics* tab.
3434
. Expand the target namespace in the list of namespaces to view the names of the topics within.
3535
Do _not_ use the *Full Name*.

modules/getting-started/pages/index.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ To learn more about the concept of tenancy, see the https://pulsar.apache.org/do
2020
You can create a tenant in the {astra-ui} or programmatically.
2121
For this quickstart, use the {astra-ui}.
2222

23-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
24-
25-
. Click *Create a Tenant*.
23+
. In the {astra-ui-link}, click **Create tenant**.
2624

2725
. Name your streaming tenant something memorable like `my-stream-**RANDOM_UUID**`.
2826
All tenant names in {product} must be unique.
@@ -32,14 +30,13 @@ All tenant names in {product} must be unique.
3230
For this example tenant, the region doesn't really matter.
3331

3432
. Click *Create Tenant*.
35-
+
36-
If the tenant is successfully created, you are redirected to the tenant's **Quickstart** tab.
33+
When the tenant is ready, it appears in the list of tenants in the {astra-ui}.
3734

3835
== Create a namespace in your tenant
3936

4037
Namespaces are logical groupings, such as environments or applications, for message topics within tenants.
4138

42-
{product} automatically creates a `default` namespaces when you create a tenant.
39+
{product} automatically creates a `default` namespace when you create a tenant.
4340
You can use the default namespace or create other namespaces.
4441
Tenants usually have many namespaces.
4542
To learn more about namespaces, see the https://pulsar.apache.org/docs/concepts-messaging/#namespaces[{pulsar-short} documentation].
@@ -48,14 +45,14 @@ You can create namespaces in the {astra-ui} or programmatically.
4845
For this quickstart, use the {astra-ui}.
4946
For information about the {pulsar-short} CLI or APIs, see xref:developing:configure-pulsar-env.adoc[] and xref:developing:using-curl.adoc[].
5047

51-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
48+
. In the {astra-ui-link}, click *Streaming tenants*.
5249

5350
. Click the name of your tenant.
5451

5552
. Click the *Namespace And Topics* tab, and then click *Create Namespace*.
5653

57-
. Enter a namespace name, and then click *Create*.
58-
. Click "Create" to create the namespace.
54+
. Enter a namespace name, and then click *Create Namespace*.
55+
The new namespace appears in the *Namespaces And Topics* list.
5956

6057
== Create a topic
6158

@@ -73,7 +70,7 @@ To learn more about topics, see the https://pulsar.apache.org/docs/concepts-mess
7370

7471
As in the previous steps, you can create topics in the {astra-ui} or programmatically.
7572

76-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
73+
. In the {astra-ui-link}, click *Streaming tenants*.
7774

7875
. Click the name of your tenant.
7976

modules/operations/pages/astream-georeplication.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ key:[null], properties:[], content:hello-from-pulsar
131131
key:[null], properties:[], content:hello-from-pulsar
132132
----
133133
134-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
134+
. In the {astra-ui-link}, click *Streaming tenants*.
135135
136136
. Click the name of your tenant, and then click the **Namespaces and Topics** tab.
137137

modules/operations/pages/astream-scrape-metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This doc will show you how to scrape an {product} tenant with Prometheus.
1111

1212
== Get the configuration file from {product}
1313

14-
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
14+
. In the {astra-ui-link}, click *Streaming tenants*.
1515

1616
. Click the name of your tenant, and then click the *Connect* tab.
1717

0 commit comments

Comments
 (0)