-
Notifications
You must be signed in to change notification settings - Fork 151
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
[Docs] Rewrite run methods and deployment docs #945
base: main
Are you sure you want to change the base?
Conversation
View the example dashboards of the current commit live on PyCafe ☕ 🚀Updated on: 2025-01-31 13:25:15 UTC Link: vizro-core/examples/dev/ Link: vizro-core/examples/scratch_dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Thanks @petar-qb, that's really helpful feedback! |
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I cannot approve this as I started it, but it looks good to me -- loads of really great content and it's very thoroughly described. I also like the split into 2 pages. Most of my changes are very minor.
Could I suggest you run Vale on the text because there are a few new product names introduced which will upset it, particularly when capitalised in headers, and they'll need to be added to the styles at some point. If you want, I can do this before merging, so just LMK.
for more information, see https://pre-commit.ci
…into docs/add-dash-enterprise
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
for more information, see https://pre-commit.ci
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
for more information, see https://pre-commit.ci
Description
@stichbury started reorganising and tidying the "Run methods" page, and @antonymilne extended the changes to rewrite much of it from scratch. This was probably the weakest part of our docs before and it's hopefully much improved now.
Reviewers: don't try to look at the diff, just look at the built docs:
https://vizro--945.org.readthedocs.build/en/945/pages/user-guides/run/
https://vizro--945.org.readthedocs.build/en/945/pages/user-guides/deploy/
Major changes:
uv
TODO:
Notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":