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

Improvements to the installation instructions #317

Open
maximlt opened this issue Aug 5, 2022 · 1 comment
Open

Improvements to the installation instructions #317

maximlt opened this issue Aug 5, 2022 · 1 comment
Assignees
Milestone

Comments

@maximlt
Copy link
Member

maximlt commented Aug 5, 2022

The Installation page mostly contains instructions to install everything that is required to run the tutorial. I would suggest to move entirely the tutorial instructions to the Setup page of the Tutorial.

The main Installation page could be in a second step extended with global installation instructions that would be valid for all the HoloViz packages, and would guide users in their install decisions, including for instance:

  • when to use conda vs pip?
  • when using conda, why choosing pyviz vs. conda-forge vs. defaults?

We could even make it more general, including docs on when and why people should pin their dependencies and how to achieve that (e.g. with anaconda-project for conda)

@jbednar
Copy link
Member

jbednar commented Aug 5, 2022

I would suggest to move entirely the tutorial instructions to the Setup page of the Tutorial.

Makes sense. The Installation page should mention that the tutorial has its own installation instructions, and that people wanting to run the tutorial should follow those instead so that they can reproduce those results reliably.

I'd be happy to see a draft of the proposed extended instructions with commentary. We could include developer instructions there, or those could go elsewhere. Not sure if pinning dependencies goes here or not; depends on the flow, I guess!

@droumis droumis assigned droumis and maximlt and unassigned droumis Aug 29, 2022
@droumis droumis added this to the next-tutorial milestone Aug 29, 2022
@jbednar jbednar mentioned this issue Jun 9, 2023
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants