Skip to content

Commit d279ae8

Browse files
Claudelukekim
authored andcommitted
docs(cloud): rename apps to projects across the portal documentation
Align the Cloud portal docs with the portal's Project terminology, and correct the delete, transfer, publish, tags, and API key flows against the current portal UI.
1 parent 637adee commit d279ae8

21 files changed

Lines changed: 137 additions & 114 deletions

cloud/SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* [Welcome to Spice.ai Cloud](README.md)
66
* [Getting Started](getting-started/get-started/README.md)
77
* [Sign in with GitHub](getting-started/get-started/portal-login.md)
8-
* [Create a Spice app](getting-started/getting-started/portal-login-1.md)
8+
* [Create a Spice project](getting-started/getting-started/portal-login-1.md)
99
* [Add a Dataset and query data](getting-started/get-started/step-2-add-dataset-and-query-data.md)
1010
* [Add AI Model and chat with your data](getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md)
1111
* [Next Steps](getting-started/get-started/next-steps.md)
@@ -20,7 +20,7 @@
2020
* [Organizations](portal/organizations.md)
2121
* [Organization Secrets](portal/organization-secrets.md)
2222
* [OAuth Clients](portal/oauth-clients.md)
23-
* [Apps](portal/apps/README.md)
23+
* [Projects](portal/apps/README.md)
2424
* [API keys](portal/apps/api-keys.md)
2525
* [Secrets](portal/apps/secrets.md)
2626
* [Tags](portal/apps/tags.md)
@@ -29,9 +29,9 @@
2929
* [Transfer](portal/apps/transfer.md)
3030
* [Delete](portal/apps/delete.md)
3131
* [Runtime](portal/apps/runtime.md)
32-
* [Public Apps](portal/public-apps.md)
32+
* [Public Projects](portal/public-apps.md)
3333
* [SpiceRack Registry](portal/spicerack.md)
34-
* [App Spicepod](portal/app-spicepod/README.md)
34+
* [Project Spicepod](portal/app-spicepod/README.md)
3535
* [Spicepod Configuration](portal/app-spicepod/spicepod-configuration.md)
3636
* [Deployments](portal/app-spicepod/deployments.md)
3737
* [Spice Runtime Versions](portal/app-spicepod/spice-runtime-versions.md)

cloud/getting-started/get-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Get started with the Spice.ai Cloud Platform in 5 mins.
1111
[portal-login.md](portal-login.md)
1212
{% endcontent-ref %}
1313

14-
### Create a Spice app
14+
### Create a Spice project
1515

1616
{% content-ref url="../getting-started/portal-login-1.md" %}
1717
[portal-login-1.md](../getting-started/portal-login-1.md)

cloud/getting-started/get-started/next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
Learn more about building AI applications and agents with the Spice.ai Cloud Platform.
44

5-
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Playground</strong></td><td>Start experimenting in the <a href="../../portal/playground/">Playground</a></td><td><a href="https://spice.ai/login">https://spice.ai/login</a></td></tr><tr><td><strong>Features</strong></td><td>Explore the <a href="/broken/pages/X0tERtTckVdb28YlZDut">features</a> of the platform</td><td><a href="../../portal/apps/">apps</a></td></tr><tr><td><strong>Use-Cases</strong></td><td>Explore <a href="/broken/pages/hpBCDc7Kl9gakSyIePLN">use-cases</a> for Spice.ai.</td><td><a href="/broken/pages/X0tERtTckVdb28YlZDut">Broken link</a></td></tr></tbody></table>
5+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Playground</strong></td><td>Start experimenting in the <a href="../../portal/playground/">Playground</a></td><td><a href="https://spice.ai/login">https://spice.ai/login</a></td></tr><tr><td><strong>Features</strong></td><td>Explore the <a href="/broken/pages/X0tERtTckVdb28YlZDut">features</a> of the platform</td><td><a href="../../portal/apps/">projects</a></td></tr><tr><td><strong>Use-Cases</strong></td><td>Explore <a href="/broken/pages/hpBCDc7Kl9gakSyIePLN">use-cases</a> for Spice.ai.</td><td><a href="/broken/pages/X0tERtTckVdb28YlZDut">Broken link</a></td></tr></tbody></table>
66

cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: circle-3
55

66
# Add a Dataset and query data
77

8-
To add a dataset to the Spice app, navigate to **Build** > [**Code**](../../portal/app-spicepod/).
8+
To add a dataset to the Spice project, navigate to **Build** > [**Code**](../../portal/app-spicepod/).
99

1010
Use the **Components sidebar** on the right to select from available **Data Connectors**, **Model Providers**, and ready-to-use **Datasets**.
1111

@@ -20,7 +20,7 @@ Use the **Components sidebar** on the right to select from available **Data Conn
2020

2121
### \[Optional] Execute a SQL query using cURL
2222

23-
6. Go app **Settings** and copy one of the app API Keys.
23+
6. Go to project **Settings** and copy one of the project API Keys.
2424
7. Replace `[API-KEY]` in the sample below with your API Key and execute from a terminal.
2525

2626
{% tabs %}

cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ models:
5050
5151
### \[Optional] Call chat completions API using cURL
5252
53-
10. Replace `[API-KEY]` in the sample below with the app API Key and execute in a terminal.
53+
10. Replace `[API-KEY]` in the sample below with the project API Key and execute in a terminal.
5454

5555
{% tabs %}
5656
{% tab title="cURL" %}

cloud/getting-started/getting-started/portal-login-1.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
description: Create your first Spice app
2+
description: Create your first Spice project
33
icon: circle-2
44
---
55

6-
# Create a Spice app
6+
# Create a Spice project
77

8-
Once [signed in with GitHub](../get-started/portal-login.md), you will be redirected to the **new application page.** Set a name, add a model provider, and optionally select one of ready to use datasets.
8+
Once [signed in with GitHub](../get-started/portal-login.md), you will be redirected to the **new project page.** Set a name, add a model provider, and optionally select one of ready to use datasets.
99

10-
1. Enter a name for the application.
10+
1. Enter a name for the project.
1111
2. Select region.
12-
3. Click **Create application**.
12+
3. Click **Create project**.
1313

14-
It will take up to 30 seconds to create and provision a dedicated Spice.ai instance for the application.
15-
4. Once the application instance is deployed and ready, you will be redirected to the [Playground](../../portal/playground/).
16-
5. Executing the `show tables` SQL query will show the default datasets available for the app.
14+
It will take up to 30 seconds to create and provision a dedicated Spice.ai instance for the project.
15+
4. Once the project instance is deployed and ready, you will be redirected to the [Playground](../../portal/playground/).
16+
5. Executing the `show tables` SQL query will show the default datasets available for the project.
1717

18-
🎉 **Congrats, you've created your first** [**Spice app**](../../portal/apps/)**!**
18+
🎉 **Congrats, you've created your first** [**Spice project**](../../portal/apps/)**!**
1919

2020
Continue to [Step. 3 to add a dataset and query it](../get-started/step-2-add-dataset-and-query-data.md).
2121

cloud/portal/app-spicepod/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
icon: cube
33
---
44

5-
# App Spicepod
5+
# Project Spicepod
66

7-
Every Spice app is powered by a managed instance of the [Spice OSS Runtime](https://www.spiceai.org/) deployed to the platform.
7+
Every Spice project is powered by a managed instance of the [Spice OSS Runtime](https://www.spiceai.org/) deployed to the platform.
88

99
A **Spicepod** is a package that encapsulates application-centric datasets and machine learning (ML) models.
1010

cloud/portal/app-spicepod/deployments.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Monitor and manage app Spicepod instances and deployments.
2+
description: Monitor and manage project Spicepod instances and deployments.
33
icon: rocket-launch
44
---
55

@@ -23,7 +23,7 @@ Each deployment listed on the **Deployments** tab reports a status derived from
2323
| **Unhealthy** | All required replicas are ready, but at least one is failing its health check. |
2424
| **Terminating** | The deployment is being replaced by a newer deployment that is ready to take traffic. |
2525
| **Succeeded** | The deployment completed and its instances are no longer reporting live state. |
26-
| **Paused** | The app is paused, so no deployment is serving. |
26+
| **Paused** | The project is paused, so no deployment is serving. |
2727
| **Created** | No live state is available for the deployment, typically because it has already been replaced. |
2828
| **Failed** | The deployment failed. |
2929

@@ -35,32 +35,32 @@ When a deployed Spicepod reports errors or warnings, the portal collects them in
3535

3636
Issues are surfaced in four places:
3737

38-
* A banner on every page of the app, listing the most recent error and the number of other errors. The banner covers errors only — warnings appear in the **Issues** panel.
39-
* An error count on the **Deployments** tab in the app navigation.
38+
* A banner on every page of the project, listing the most recent error and the number of other errors. The banner covers errors only — warnings appear in the **Issues** panel.
39+
* An error count on the **Deployments** tab in the project navigation.
4040
* An **Issues** panel on the **Deployments** page, and on each instance page scoped to that instance. Each panel lists up to five issues and links to the full list.
41-
* A dedicated **Issues** page for the app, listing every issue without a limit.
41+
* A dedicated **Issues** page for the project, listing every issue without a limit.
4242
* An indicator on the affected row in **Datasets** and **Models**, when an issue can be attributed to a component.
4343

4444
The feed combines runtime `ERROR` and `WARN` log lines with the reported status of each dataset. Repeats of the same failure collapse into one row with an occurrence count, so a connector retrying every second appears once rather than hundreds of times.
4545

46-
Issues are ordered errors first, then by how often they occurred, then by how recently. A panel capped at five rows therefore shows the errors before any warning, and the panel header keeps the full error and warning counts for the app or instance. **View all** *N* **issues** in the panel footer opens the dedicated **Issues** page, which lists the entire set.
46+
Issues are ordered errors first, then by how often they occurred, then by how recently. A panel capped at five rows therefore shows the errors before any warning, and the panel header keeps the full error and warning counts for the project or instance. **View all** *N* **issues** in the panel footer opens the dedicated **Issues** page, which lists the entire set.
4747

4848
Each row shows where the issue came from, how many times it occurred, when it was last seen, the dataset or model it was attributed to, and the instance that reported it. **Show details** expands the full text, including stack traces. The link on the row opens the originating instance's logs filtered to the issue, or the component's page for an issue reported by a dataset.
4949

5050
{% hint style="info" %}
5151
Dismissing an error hides that specific error. A different failure raises the banner again.
5252
{% endhint %}
5353

54-
An app with no issues shows no banner, no count, and no panel. The dedicated **Issues** page remains reachable and reports that no issues were detected.
54+
A project with no issues shows no banner, no count, and no panel. The dedicated **Issues** page remains reachable and reports that no issues were detected.
5555

5656
#### Get AI help
5757

58-
Each issue row has a **Get AI help** action that analyzes that issue on demand. The analysis reads the app's recent runtime logs and returns a likely root cause, a short numbered list of fix steps, links to the relevant documentation, and a confidence level.
58+
Each issue row has a **Get AI help** action that analyzes that issue on demand. The analysis reads the project's recent runtime logs and returns a likely root cause, a short numbered list of fix steps, links to the relevant documentation, and a confidence level.
5959

6060
Results are generated per issue and are not produced until the action is used.
6161

6262
{% hint style="warning" %}
63-
An AI analysis is a suggestion, not a diagnosis. Verify each step against the app's own configuration before applying it.
63+
An AI analysis is a suggestion, not a diagnosis. Verify each step against the project's own configuration before applying it.
6464
{% endhint %}
6565

6666
### Spicepod Instance Logs

cloud/portal/app-spicepod/spice-runtime-versions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ icon: gear
44

55
# Spice Runtime Versions
66

7-
Each new app deployment automatically retrieves the most recent stable Spice OSS release. Visit the [Releases page](https://github.com/spiceai/spiceai/releases) or [Spice OSS blog](https://spiceai.org/blog) to check for the latest runtime updates.
7+
Each new project deployment automatically retrieves the most recent stable Spice OSS release. Visit the [Releases page](https://github.com/spiceai/spiceai/releases) or [Spice OSS blog](https://spiceai.org/blog) to check for the latest runtime updates.
88

9-
### Migrate Exiting Apps
9+
### Migrate Existing Projects
1010

11-
All Spice Apps are now powered by the latest, next-generation Spice.ai Open Source data and AI engine. Existing apps have been migrated but require a manual setup step to connect datasets and/or model providers.
11+
All Spice projects are now powered by the latest Spice.ai Open Source data and AI engine. Existing projects have been migrated but require a manual setup step to connect datasets and/or model providers.
1212

1313
Learn More: Read the [Announcing 1.0-stable](https://spiceai.org/blog/announcing-1.0-stable) blog post for details on this upgrade, and visit the [Spice.ai Cookbook](https://spiceai.org/cookbook) for over 50 quickstarts and examples.

cloud/portal/app-spicepod/spicepod-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ icon: square-code
44

55
# Spicepod Configuration
66

7-
### Edit app spicepod not connected to GitHub
7+
### Edit project spicepod not connected to GitHub
88

9-
To update Spice App spicepod.yaml, navigate to **Build** > **Code**. Use Components sidebar to add data connectors, model providers and preconfigured datasets, or manually edit spicepod.yaml in code editor.
9+
To update the Spice project spicepod.yaml, navigate to **Build** > **Code**. Use Components sidebar to add data connectors, model providers and preconfigured datasets, or manually edit spicepod.yaml in code editor.
1010

1111
After saving the spicepod changes, a new deployment must be triggered. Learn more about [Spicepod Deployments](deployments.md).
1212

13-
### Edit app spicepod connected to GitHub
13+
### Edit project spicepod connected to GitHub
1414

15-
If the Spice App is connected to a GitHub repository ([learn more](../apps/connect-github.md) about how to connect), the only way to update the Spicepod configuration is to edit the spicepod.yaml file in the root of your repository and push it to the default branch.
15+
If the Spice project is connected to a GitHub repository ([learn more](../apps/connect-github.md) about how to connect), the only way to update the Spicepod configuration is to edit the spicepod.yaml file in the root of your repository and push it to the default branch.
1616

1717
To apply the updated spicepod, a new deployment must be triggered. Learn more about [Spicepod Deployments](deployments.md).
1818

0 commit comments

Comments
 (0)