Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for ploomber-cloud labels --sync #261

Merged
merged 8 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,14 @@ To view all labels added to your project simply run:
ploomber-cloud labels
```

### Synchronize labels

To overwrite the labels in your `ploomber-cloud.json` with the labels from the UI:

```sh
ploomber-cloud labels --sync
```
bryannho marked this conversation as resolved.
Show resolved Hide resolved

## Switching the configuration file

By default, the CLI reads and writes to a `ploomber-cloud.json` file, but you can customize it via the `--config` (or its short version, `-c`), switching the config file is useful when you need to manage multiple environments (for example, development and production).
Expand All @@ -382,4 +390,4 @@ ploomber-cloud init --config ploomber-cloud.dev.json

# deploy using the dev config
ploomber-cloud deploy --config ploomber-cloud.dev.json
```
```
4 changes: 3 additions & 1 deletion doc/user-guide/managing-apps.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Managing applications

## Labels

Labels can help you organize and identify your apps. You can add them during creation:

![](../static/manage-apps/labels.png)
Expand All @@ -18,6 +17,9 @@ You may add as many labels as you want. Once you've added some labels, they will

![](../static/manage-apps/see-labels-main.png)

```{tip}
You can add labels to your app through the [CLI](./cli.md#add-labels)
```

(stop-application)=
## Stop application
Expand Down
4 changes: 2 additions & 2 deletions examples/panel/stock-market-chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The app is built using Python Yahoo Finance [yfinance](https://pypi.org/project/

The app will store the plot generated and save it to ImageKit.io, and then use the OpenAI API to generate a response to the user's question about the plot.

### Pre-requisites
### Prerequisites

1. OpenAI API key. Visit their [Documentation](https://platform.openai.com/docs/api-reference/introduction)
2. ImageKit.io url endpoint, public key, and private key. Visit their [Dashboard](https://imagekit.io/dashboard)
Expand Down Expand Up @@ -56,4 +56,4 @@ panel serve app.py --autoreload --show
To deploy the app to Ploomber Cloud, you need to have a Ploomber Cloud account. Visit their [website](https://www.platform.ploomber.io/) to create an account. Once you have an account, you can deploy the Panel app to Ploomber Cloud using the following guides:

[Deploy Panel apps through the UI](https://docs.cloud.ploomber.io/en/latest/apps/panel.html).
[Add your secret variables](https://docs.cloud.ploomber.io/en/latest/user-guide/env-vars.html)
[Add your secret variables](https://docs.cloud.ploomber.io/en/latest/user-guide/env-vars.html)