From ed1564adb5db84d0889952d9f2bef1db2f0bf6f8 Mon Sep 17 00:00:00 2001 From: Bryan Ho Date: Thu, 7 Mar 2024 19:11:13 -0500 Subject: [PATCH] Update Dash documentation (#141) * update dash and cli note * word --- doc/apps/dash.md | 51 +++++++++++++++++++++++++++++++++++++++++-- doc/user-guide/cli.md | 2 +- 2 files changed, 50 insertions(+), 3 deletions(-) diff --git a/doc/apps/dash.md b/doc/apps/dash.md index 1a27157a..9b047aea 100644 --- a/doc/apps/dash.md +++ b/doc/apps/dash.md @@ -32,11 +32,58 @@ gunicorn app:server run --bind 0.0.0.0:5000 Now, open [http://0.0.0.0:5000/](http://0.0.0.0:5000/) to see your app. - ## Deploy +`````{tab-set} + +````{tab-item} Web +__Deploy from the menu__ + Once you have all your files, create a zip file. To deploy a Dash app from the deployment menu, select the Dash option and follow the instructions: -![](../static/dash.png) \ No newline at end of file +![](../static/dash.png) +```` + +````{tab-item} Command-line +__Try an example__ + +To download and deploy an example Dash application start by installing Ploomber Cloud and setting your API key: + +```sh +pip install ploomber-cloud +ploomber-cloud key YOUR-KEY +``` + +```{tip} +If you don't have an API key yet, follow the [instructions here.](../quickstart/apikey.md) +``` + +Now, download an example. It will prompt you for a location to download the app. To download in the current directory, just press enter. + +```sh +ploomber-cloud examples dash/clinical-analytics +``` + +```{note} +A full list of Dash example apps is available [here.](https://github.com/ploomber/doc/tree/main/examples/dash) +``` + +You should see a confirmation with instructions on deploying your app. Now, navigate to your application: + +```sh +cd location-you-entered/clinical-analytics +``` + +__Deploy from the CLI__ + +Initialize and deploy your app with: + +```sh +ploomber-cloud init +ploomber-cloud deploy --watch +``` + +```` +````` \ No newline at end of file diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md index fee11bfc..4fb3b8be 100644 --- a/doc/user-guide/cli.md +++ b/doc/user-guide/cli.md @@ -1,7 +1,7 @@ # Command-line interface ```{note} -Currently, Voila deployments are unsupported by the CLI. Environment variables and authentication are also unsupported. Expect support to be added soon. +Currently, authentication is unsupported by the CLI. Expect support to be added soon. ``` You can deploy applications using the command-line interface. First, install the package: