[DRAFT][Docs] Revise run methods/deployment docs

[stichbury]

Description

I've made a few changes in the run.md file to improve readability. This is on top of the change to come to add Dash Enterprise to this page (I have separated that change into a separate PR: #947).

1. I have a question: should the Gunicorn section go under deployment? It mentions deployment so naturally would fit better, right?
2. Also, and maybe related, I am concerned that we aren't that tight about language, or maybe it's my understanding. The file is called run.md and the ToC had the page listed as "Run methods" but we mostly talk about "launching" and then Gunicorn talks about deployment, then there's a section on deployment.

Can I get clarity on the difference, or not, in what we mean by "run", "launch" and "deploy" and then I'll run through again and ensure everything is consistent.

Screenshot

Notice

• I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
  • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
  • I have not referenced individuals, products or companies in any commits, directly or indirectly.
  • I have not added data or restricted code in any commits, directly or indirectly.

[github-actions]

View the example dashboards of the current commit live on PyCafe ☕ 🚀

Updated on: 2025-01-15 14:55:40 UTC
Commit: c8c4cb9

Link: vizro-core/examples/dev/

Link: vizro-core/examples/scratch_dev

Link: vizro-core/examples/visual-vocabulary/

Link: vizro-ai/examples/dashboard_ui/

[petar-qb]

Really great refactoring 👍

I have a question: should the Gunicorn section go under deployment? It mentions deployment so naturally would fit better, right?

I agree that the "Gunicorn" section should go under the "Deployment". Great spot!

Also, and maybe related, I am concerned that we aren't that tight about language, or maybe it's my understanding. The file is called run.md and the ToC had the page listed as "Run methods" but we mostly talk about "launching" and then Gunicorn talks about deployment, then there's a section on deployment. Can I get clarity on the difference, or not, in what we mean by "run", "launch" and "deploy" and then I'll run through again and ensure everything is consistent.

I understand the confusion because these terms are quite intertwined here.
So, "run" and "launch" are the same terms that describe running/launching the app locally (for the development purpose).
However, deployment means more like setting-up and running the production-ready app somewhere on the server (not locally).

Also, I like the "Launch the dashboard" title, and also the suggestion to move "Gunicorn" under the "Deployment" section. I guess we should rename the file from run.md -> launch_the_dashboard.md, and align wordings across documents accordingly.

[stichbury]

Thanks @petar-qb, that's really helpful feedback!