Merge pull request #68 from ploomber/67-rename-dashboard-application

rename dashboard -> application
ploomber · Jan 18, 2024 · 0831cab · 0831cab
2 parents 2674158 + 14a85b0
commit 0831cab
Show file tree

Hide file tree

Showing 34 changed files with 28 additions and 28 deletions.
diff --git a/doc/apps/chalk-it.md b/doc/apps/chalk-it.md
@@ -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`
 
@@ -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
@@ -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.

diff --git a/doc/apps/voila.md b/doc/apps/voila.md
@@ -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)
 

diff --git a/doc/quickstart/app.md b/doc/quickstart/app.md
@@ -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)
diff --git a/doc/static/account.png b/doc/static/account.png
diff --git a/doc/static/applications-form.png b/doc/static/applications-form.png
diff --git a/doc/static/dashboards-logs.png → doc/static/applications-logs.png b/doc/static/dashboards-logs.png → doc/static/applications-logs.png
diff --git a/doc/static/applications-new.png b/doc/static/applications-new.png
diff --git a/doc/static/applications-progress.png b/doc/static/applications-progress.png
diff --git a/doc/static/applications-view.png b/doc/static/applications-view.png
diff --git a/...dashboards/jupyterlab-plugin/1-button.png → ...plications/jupyterlab-plugin/1-button.png b/...dashboards/jupyterlab-plugin/1-button.png → ...plications/jupyterlab-plugin/1-button.png
diff --git a/...ards/jupyterlab-plugin/2-requirements.png → ...ions/jupyterlab-plugin/2-requirements.png b/...ards/jupyterlab-plugin/2-requirements.png → ...ions/jupyterlab-plugin/2-requirements.png
diff --git a/...rds/jupyterlab-plugin/3-enter-api-key.png → ...ons/jupyterlab-plugin/3-enter-api-key.png b/...rds/jupyterlab-plugin/3-enter-api-key.png → ...ons/jupyterlab-plugin/3-enter-api-key.png
diff --git a/...ashboards/jupyterlab-plugin/4-api-key.png → ...lications/jupyterlab-plugin/4-api-key.png b/...ashboards/jupyterlab-plugin/4-api-key.png → ...lications/jupyterlab-plugin/4-api-key.png
diff --git a/...ashboards/jupyterlab-plugin/5-confirm.png → ...lications/jupyterlab-plugin/5-confirm.png b/...ashboards/jupyterlab-plugin/5-confirm.png → ...lications/jupyterlab-plugin/5-confirm.png
diff --git a/...ic/dashboards/jupyterlab-plugin/6-url.png → .../applications/jupyterlab-plugin/6-url.png b/...ic/dashboards/jupyterlab-plugin/6-url.png → .../applications/jupyterlab-plugin/6-url.png
diff --git a/doc/static/copy-api-key.png b/doc/static/copy-api-key.png
diff --git a/doc/static/dashboards-form.png b/doc/static/dashboards-form.png
diff --git a/doc/static/dashboards-new.png b/doc/static/dashboards-new.png
diff --git a/doc/static/dashboards-progress.png b/doc/static/dashboards-progress.png
diff --git a/doc/static/dashboards-view.png b/doc/static/dashboards-view.png
diff --git a/doc/static/docker.png b/doc/static/docker.png
diff --git a/doc/static/env-vars/env-vars-section.png b/doc/static/env-vars/env-vars-section.png
diff --git a/doc/static/panel.png b/doc/static/panel.png
diff --git a/doc/static/streamlit.png b/doc/static/streamlit.png
diff --git a/doc/static/voila.png b/doc/static/voila.png
diff --git a/doc/static/web-home.png b/doc/static/web-home.png
diff --git a/doc/user-guide/github.md b/doc/user-guide/github.md
@@ -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

diff --git a/examples/ml/requirements.txt b/examples/ml/requirements.txt
@@ -1,4 +1,4 @@
-# requirements for ml dashboard
+# requirements for ml application
 seaborn   
 scikit-learn
 pandas

diff --git a/examples/quickstart/notebook.ipynb b/examples/quickstart/notebook.ipynb
@@ -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"
    ]
   },
   {

diff --git a/examples/quickstart/requirements.txt b/examples/quickstart/requirements.txt
@@ -1,4 +1,4 @@
-# requirements for analytical dashboard
+# requirements for analytical application
 jupysql
 duckdb
 duckdb-engine

diff --git a/examples/voila/jupysql/notebook.ipynb b/examples/voila/jupysql/notebook.ipynb
@@ -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"
    ]
   },
   {

diff --git a/examples/voila/jupysql/requirements.txt b/examples/voila/jupysql/requirements.txt
@@ -1,4 +1,4 @@
-# requirements for analytical dashboard
+# requirements for analytical application
 jupysql
 duckdb
 duckdb-engine

diff --git a/examples/voila/ml/requirements.txt b/examples/voila/ml/requirements.txt
@@ -1,4 +1,4 @@
-# requirements for ml dashboard
+# requirements for ml application
 seaborn   
 scikit-learn
 pandas

diff --git a/examples/voila/mosaic/notebook.ipynb b/examples/voila/mosaic/notebook.ipynb
@@ -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",
@@ -283,4 +283,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 0
-}
+}