8000 doc: add more installation methods by kemingy · Pull Request #1300 · tensorchord/envd · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

doc: add more installation methods #1300

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 13, 2022
Merged

doc: add more installation methods #1300

merged 1 commit into from
Dec 13, 2022

Conversation

kemingy
Copy link
Member
@kemingy kemingy commented Dec 13, 2022

Signed-off-by: Keming kemingyang@tensorchord.ai

@kemingy
doc: add more installation methods
e1f2b6c 
Signed-off-by: K
8000
eming <kemingyang@tensorchord.ai>
gaocegege
gaocegege reviewed Dec 13, 2022
View reviewed changes
@gaocegege gaocegege merged commit 0a416d1 into tensorchord:main Dec 13, 2022
@kemingy kemingy deleted the readme_install branch December 13, 2022 09:39
@frostming
Copy link
Contributor

It surprises me that there is no 'installation' section in the docs, or is there one that I missed?

IMHO we should list recommended installation methods together with alternatives in the docs, and keep the installation part in README simple.

@kemingy
Copy link
Member Author
kemingy commented Dec 13, 2022

It surprises me that there is no 'installation' section in the docs, or is there one that I missed?

IMHO we should list recommended installation methods together with alternatives in the docs, and keep the installation part in README simple.

The current installation section doesn't have enough instructions for beginners. Users may not know "how to add it to the PATH" or "why I'm using the old one even after pip install -U --pre envd".

I agree we should improve the installation section.

@frostming
Copy link
Contributor
frostming commented Dec 13, 2022 •
edited
Loading

@kemingy Yeah, we can add an installation section to Building Your First Environment page(P.S. the page title is different from sidebar entry :P), or in its own page. We can then make it more verbose and clear there, and leave a link referring to the docs in README. What's more, we can make a more beautiful UI for it, such as a tab component to switch different installation methods.

@gaocegege
Copy link
Member

BTW, should we remove --pre from the script? Since we will follow the semver to publish new releases.

@gaocegege gaocegege mentioned this pull request Dec 13, 2022
Closed
@kemingy
Copy link
Member Author
kemingy commented Dec 14, 2022

BTW, should we remove --pre from the script? Since we will follow the semver to publish new releases.

Agree. cc @frostming you can delete --pre when you're trying to work on tensorchord/envd-docs#204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaocegege gaocegege gaocegege left review comments

@VoVAllen VoVAllen Awaiting requested review from VoVAllen VoVAllen is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kemingy @frostming @gaocegege
0