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

rename dashboard -> application #68

Merged
merged 7 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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: 5 additions & 5 deletions doc/apps/chalk-it.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To deploy a [Chalk'it](https://github.com/ifpen/chalk-it) application in Ploomber Cloud you need:

- A `Dockerfile`
- A Chalk'it projet definition JSON file renamed to `dashboard.xprjson`
- A Chalk'it projet definition JSON file renamed to `application.xprjson`

## `Dockerfile`

Expand All @@ -12,8 +12,8 @@ You just need to use this [template](https://github.com/ploomber/doc/blob/main/e
```Dockerfile
FROM python:3.11

# assume your dashboard is named dashboard.xprjson
COPY dashboard.xprjson dashboard.xprjson
# assume your application is named application.xprjson
COPY application.xprjson application.xprjson

# install py-chalk-it and gunicorn
RUN pip install py-chalk-it gunicorn
Expand All @@ -28,10 +28,10 @@ To test your app, you can use `docker` locally:

```sh
# build the docker image
docker build . -t dashboard
docker build . -t application

# run it
docker run -p 5000:80 dashboard
docker run -p 5000:80 application
```

Now, open [http://0.0.0.0:5000/](http://0.0.0.0:5000/) to see your app.
Expand Down
6 changes: 3 additions & 3 deletions doc/apps/voila.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Voilà

```{tip}
If you haven't deployed your first dashboard, check out the [quickstart guide.](../quickstart/app.md)
If you haven't deployed your first application, check out the [quickstart guide.](../quickstart/app.md)
```

To deploy a dashboard you need two files:
To deploy a application you need two files:

1. A Jupyter notebook file (`.ipynb`)
2. A dependencies file (`requirements.txt`)

## Voilà

Currently, Ploomber Cloud supports [Voilà](https://voila.readthedocs.io/en/stable/) for deploying Jupyter notebooks as dashboards. For information on how to write Voilà dashboards, [please check the documentation](https://voila.readthedocs.io/en/stable/).
Currently, Ploomber Cloud supports `Voilà` for deploying Jupyter notebooks as applications. For information on how to write Voilà applications, [please check the documentation](https://voila.readthedocs.io/en/stable/).

Click here to see [some examples.](../examples/voila.md)

Expand Down
16 changes: 8 additions & 8 deletions doc/quickstart/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@
You can also deploy from the [terminal](../user-guide/cli.md) or [GitHub](../user-guide/github.md)
```

## 1. Click on "Dashboards" -> "New"
## 1. Click on "Applications" -> "New"

![](../static/dashboards-new.png)
![](../static/applications-new.png)


## 2. Fill out the form


![](../static/dashboards-form.png)
![](../static/applications-form.png)

## 3. Wait for the deployment to finish

You'll see two tabs. First, you'll see the `DOCKER LOGS`, which show the progress of installing your dashboards's dependencies:
You'll see two tabs. First, you'll see the `DOCKER LOGS`, which show the progress of installing your applications's dependencies:

![](../static/dashboards-logs.png)
![](../static/applications-logs.png)

You can track progress completion from the status bar:


![](../static/dashboards-progress.png)
![](../static/applications-progress.png)

At the beginning the `VIEW DASHBOARD` button in the top right will be greyed out, once deployment finalizes, you'll be able to click on it to see your app!
At the beginning the `VIEW APPLICATION` button in the top right will be greyed out, once deployment finalizes, you'll be able to click on it to see your app!

![](../static/dashboards-view.png)
![](../static/applications-view.png)
Binary file modified doc/static/account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/applications-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added doc/static/applications-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/applications-progress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/applications-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/copy-api-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/static/dashboards-form.png
Binary file not shown.
Binary file removed doc/static/dashboards-new.png
Binary file not shown.
Binary file removed doc/static/dashboards-progress.png
Binary file not shown.
Binary file removed doc/static/dashboards-view.png
Binary file not shown.
Binary file modified doc/static/docker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/streamlit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/voila.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/web-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/user-guide/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ Then, click on the most recent run, and you'll see the logs:

![](../static/github/logs-watch.png)

In the logs, you will see updates on the progress of the deployment. You'll also see a URL to your project dashboard where you can check its status.
In the logs, you will see updates on the progress of the deployment. You'll also see a URL to your application where you can check its status.
Once the deployment has succeeded, it will return a URL to view your deployed project.

If you would prefer to track progress only through the project dashboard, you can remove `--watch` from the `deploy` command in your `ploomber-cloud.yaml`:
If you would prefer to track progress only through the application, you can remove `--watch` from the `deploy` command in your `ploomber-cloud.yaml`:

```yaml
- name: Deploy
Expand Down
2 changes: 1 addition & 1 deletion examples/ml/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# requirements for ml dashboard
# requirements for ml application
seaborn
scikit-learn
pandas
Expand Down
4 changes: 2 additions & 2 deletions examples/quickstart/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Analytical dashboard\n",
"# Analytical application\n",
"\n",
"> This dashboard helps you explore the penguins dataset"
"> This application helps you explore the penguins dataset"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# requirements for analytical dashboard
# requirements for analytical application
jupysql
duckdb
duckdb-engine
Expand Down
4 changes: 2 additions & 2 deletions examples/voila/jupysql/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Analytical dashboard\n",
"# Analytical application\n",
"\n",
"> This dashboard helps you explore the penguins dataset"
"> This application helps you explore the penguins dataset"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/voila/jupysql/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# requirements for analytical dashboard
# requirements for analytical application
jupysql
duckdb
duckdb-engine
Expand Down
2 changes: 1 addition & 1 deletion examples/voila/ml/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# requirements for ml dashboard
# requirements for ml application
seaborn
scikit-learn
pandas
Expand Down
4 changes: 2 additions & 2 deletions examples/voila/mosaic/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"source": [
"## Interactive data visualization\n",
"\n",
"This dashboard uses [mosaic](https://uwdata.github.io/mosaic/) to display three linked visualizations.\n",
"This application uses [mosaic](https://uwdata.github.io/mosaic/) to display three linked visualizations.\n",
"\n",
"Data: [Cross-filter flights (10M)](https://uwdata.github.io/mosaic/examples/flights-10m.html#cross-filter-flights-10m).\n",
"The dataset is a part of the [ASA Data Expo](https://community.amstat.org/jointscsg-section/dataexpo/dataexpo2009) dataset and consists of flight arrival and departure details for all commercial flights within the USA, from October 1987 to April 2008.\n",
Expand Down Expand Up @@ -283,4 +283,4 @@
},
"nbformat": 4,
"nbformat_minor": 0
}
}