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

Change installation instructions to suggest installing from pypi instead of git clone #124

Closed
garrison opened this issue May 2, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@garrison
Copy link
Member

garrison commented May 2, 2023

At some point, we will likely want to change the installation instructions to suggest that users install the latest stable version via pip install from pypi rather than the latest development version (main branch) via git clone.

A few open questions, though:

  1. When is the timing best for making this change?
  2. How do we anticipate the user will obtain the correct tutorial notebooks? (They won't be provided by any pip install command.)
  3. Do we want to update the Dockerfile, too, so that it installs the latest released version?
  4. Should we, concurrently with this change, make it so the latest stable version's documentation is hosted on the web?
@garrison garrison added the documentation Improvements or additions to documentation label May 2, 2023
@garrison garrison changed the title Change installation instructions to suggest installing via pip install instead of git clone Change installation instructions to suggest installing from pypi instead of git clone May 3, 2023
@garrison
Copy link
Member Author

garrison commented May 30, 2023

(1) is addressed by #213, and we are punting on (2). We should plan to revisit (3) and (4) soon.

@garrison
Copy link
Member Author

garrison commented Apr 4, 2024

We now deploy docs from the stable branch, so (4) is complete.

@garrison
Copy link
Member Author

I think everything actionable here is done. For (2), if somebody wants the Dockerfile to use a released version, they should check out that version's tag first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant