deephaven / deephaven-docs-community

Source code for Community docs on the deephaven.io website.
Apache License 2.0
0 stars 5 forks source link

pip Quickstart and guide updates #242

Closed margaretkennedy closed 1 week ago

margaretkennedy commented 4 months ago

Chip recommends a Quickstart for pip, rather than only under "Advanced Installation."

Feedback on current guide:

The pip install guide is not very good. https://docs-staging.deephaven.io/deploy-preview/pr-4026/core/docs/tutorials/pip-install/. The biggest problem I have with it is running using the python command and the deephaven command. The differences are not covered well. For example, the code differences and what that means for the commands yields a muddled mess that I'm sure is going to trip up users. Furthermore, the UGP section seems bizarre to be here. I don't understand why it would be included in this document. Overall, the whole document needs a major, careful redo. There is no clear story, and what is there is a mess. It doesn't list packages that need to be installed