From 1c8198c5ae3fce9ef06f0b08cb04c1906f9c98af Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Tue, 9 Jul 2024 20:37:09 -0400 Subject: [PATCH 1/8] trivial wordsmithing --- examples/panel/stock-market-chatbot/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/panel/stock-market-chatbot/README.md b/examples/panel/stock-market-chatbot/README.md index fe4df9e9..1f5acfe8 100644 --- a/examples/panel/stock-market-chatbot/README.md +++ b/examples/panel/stock-market-chatbot/README.md @@ -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) @@ -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) \ No newline at end of file +[Add your secret variables](https://docs.cloud.ploomber.io/en/latest/user-guide/env-vars.html) From c70b0984dbf9b735f0d58b4cf0767a05dfb379c5 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 12:59:52 -0400 Subject: [PATCH 2/8] add documentation for `ploomber-cloud labels --sync` --- doc/user-guide/cli.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md index 6e8efebc..84095fb3 100644 --- a/doc/user-guide/cli.md +++ b/doc/user-guide/cli.md @@ -370,6 +370,14 @@ To view all labels added to your project simply run: ploomber-cloud labels ``` +### Synchronize labels + +To update your local config with the labels from the UI: + +```sh +ploomber-cloud labels --sync +``` + ## 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). @@ -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 -``` \ No newline at end of file +``` From 2ab5a30a29406b24b0ed511dbb9d28b115b8121b Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 18:44:01 -0400 Subject: [PATCH 3/8] Update doc/user-guide/cli.md Co-authored-by: Bryan Ho --- doc/user-guide/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md index 84095fb3..5183a304 100644 --- a/doc/user-guide/cli.md +++ b/doc/user-guide/cli.md @@ -372,7 +372,7 @@ ploomber-cloud labels ### Synchronize labels -To update your local config with the labels from the UI: +To update your local `ploomber-cloud.json` file with the labels from the UI: ```sh ploomber-cloud labels --sync From 555bd0eb25f9982fdcbaad0a323dc5da4ea81d69 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 18:43:51 -0400 Subject: [PATCH 4/8] wordsmithing --- doc/user-guide/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md index 5183a304..b1879f11 100644 --- a/doc/user-guide/cli.md +++ b/doc/user-guide/cli.md @@ -372,7 +372,7 @@ ploomber-cloud labels ### Synchronize labels -To update your local `ploomber-cloud.json` file with the labels from the UI: +To overwrite the labels in your `ploomber-cloud.json` with the labels from the UI: ```sh ploomber-cloud labels --sync From df363409711b389fef3a9fe78bc7f152109d2313 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 18:47:41 -0400 Subject: [PATCH 5/8] add tip --- doc/user-guide/managing-apps.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/user-guide/managing-apps.md b/doc/user-guide/managing-apps.md index 378621fe..3cd56724 100644 --- a/doc/user-guide/managing-apps.md +++ b/doc/user-guide/managing-apps.md @@ -18,6 +18,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 also add labels to your app through the [CLI](link-to-CLI-labels-section) +``` (stop-application)= ## Stop application From 6596cb9dd26b09a3a1445d2e07a231a474d04df2 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 18:50:47 -0400 Subject: [PATCH 6/8] Revert "add tip" This reverts commit df363409711b389fef3a9fe78bc7f152109d2313. --- doc/user-guide/managing-apps.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/user-guide/managing-apps.md b/doc/user-guide/managing-apps.md index 3cd56724..378621fe 100644 --- a/doc/user-guide/managing-apps.md +++ b/doc/user-guide/managing-apps.md @@ -18,9 +18,6 @@ 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 also add labels to your app through the [CLI](link-to-CLI-labels-section) -``` (stop-application)= ## Stop application From d8d518b0715aa6d9a325427db2417dafd412ce43 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Thu, 1 Aug 2024 18:52:55 -0400 Subject: [PATCH 7/8] add tip --- doc/user-guide/managing-apps.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/user-guide/managing-apps.md b/doc/user-guide/managing-apps.md index 378621fe..6c1a9aab 100644 --- a/doc/user-guide/managing-apps.md +++ b/doc/user-guide/managing-apps.md @@ -1,7 +1,9 @@ # Managing applications ## Labels - +```{tip} +You can add labels to your app through the [CLI](./cli.md#add-labels) +``` Labels can help you organize and identify your apps. You can add them during creation: ![](../static/manage-apps/labels.png) From 636f10183950535c600456653da2986448f17357 Mon Sep 17 00:00:00 2001 From: Keenan Sanchez Date: Fri, 2 Aug 2024 12:24:24 -0400 Subject: [PATCH 8/8] move tip to end of file --- doc/user-guide/managing-apps.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/user-guide/managing-apps.md b/doc/user-guide/managing-apps.md index 6c1a9aab..d24af827 100644 --- a/doc/user-guide/managing-apps.md +++ b/doc/user-guide/managing-apps.md @@ -1,9 +1,6 @@ # Managing applications ## Labels -```{tip} -You can add labels to your app through the [CLI](./cli.md#add-labels) -``` Labels can help you organize and identify your apps. You can add them during creation: ![](../static/manage-apps/labels.png) @@ -20,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