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

docs: install dtm with asdf in quickstart #960

Merged
merged 4 commits into from
Aug 10, 2022

Conversation

zhenyuanlau
Copy link
Contributor

@zhenyuanlau zhenyuanlau commented Aug 7, 2022

Signed-off-by: Zhenyuan Lau zhenyuanlau@outlook.com

Pre-Checklist

Note: please complete ALL items in the following checklist.

  • I have read through the CONTRIBUTING.md documentation.
  • My code has the necessary comments and documentation (if needed).
  • I have added relevant tests

Description

Add install dtm with asdf section in quickstart.md file.

Related Issues

New Behavior (screenshots if needed)

image
image

Signed-off-by: Zhenyuan Lau <zhenyuanlau@outlook.com>
@iyear
Copy link
Member

iyear commented Aug 8, 2022

Hi @zhenyuanlau , thanks for your contribution! Please join CNCF's Slack, and join our channel in CNCF Slack!
Here are a few useful things for you to continue your open-source journey:

Copy link
Member

@iyear iyear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for your contribution, I have seen asdf-vm/asdf-plugins#635 and https://github.com/zhenyuanlau/asdf-dtm.

Being able to customize a new installation for devstream means getting familiar with it! 🚀

@aFlyBird0
Copy link
Member

aFlyBird0 commented Aug 8, 2022

Thank you very much for your contribution! I noticed that even the dtm plugin for asdf was provided by you, thanks again! @zhenyuanlau

Perhaps we have the following issues to discuss/notice.

  1. quick start in should be as "quick" as possible. If you use asdf installation, then the user needs to visit the asdf official website and spend time configuring asdf first, which will take some time. Maybe we can create a new page installation to talk specifically about how to install dtm in various ways? cc @IronCore864 @daniel-hutao
  2. I cloned the latest asdf repository code and encountered the error No such plugin: dtm when executing asdf list-all dtm. But I see that the official plugin repository https://github.com/asdf-vm/asdf-plugins/blob/master/plugins/dtm already has dtm. So theoretically you should not need to install additional plugins. Can you solve this problem?
  3. I noticed that your new documentation only installs the dtm binary, but our quick start script also automatically downloads the default quick start configuration file. So the two are not equivalent. However, if we follow the first (asdf installation in a separate document), then this document is fine. That is, focus only on installing the binaries themselves.

@IronCore864
Copy link
Member

The goal of the quick start doc is to enable first-time users to get started as quickly as possible with as few dependencies as possible. That's why we tried to put everything into a shell script.

While asdf is a great tool, it doesn't fit in the quick start doc.

Maybe we can create another documentation specifically for installing dtm using asdf?

@aFlyBird0
Copy link
Member

After my tests on Unbuntu 20.04, there is no problem with this installation process itself, thanks again!

root@VM-16-17-ubuntu:/home/lhp# asdf install dtm latest
No such plugin: dtm
root@VM-16-17-ubuntu:/home/lhp# asdf plugin add dtm https://github.com/zhenyuanlau/asdf-dtm.git
root@VM-16-17-ubuntu:/home/lhp# asdf list-all dtm
0.0.1-rc1
0.0.1
0.0.2
0.1.0
0.2.0
0.3.0
0.3.1
0.3.2
0.4.0
0.5.0
0.6.0
0.6.1
0.7.0

root@VM-16-17-ubuntu:/home/lhp# asdf install dtm latest
Got OS type: linux and CPU arch: amd64
* Downloading dtm release 0.7.0...
dtm 0.7.0 installation was successful!
root@VM-16-17-ubuntu:/home/lhp# asdf global dtm latest
root@VM-16-17-ubuntu:/home/lhp# dtm version
0.7.0

@aFlyBird0 aFlyBird0 self-requested a review August 8, 2022 02:24
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.zh.md Outdated Show resolved Hide resolved
Signed-off-by: Zhenyuan Lau <zhenyuanlau@outlook.com>
Signed-off-by: Zhenyuan Lau <zhenyuanlau@outlook.com>
@zhenyuanlau zhenyuanlau requested review from daniel-hutao and a team as code owners August 8, 2022 05:05
@zhenyuanlau zhenyuanlau requested a review from aFlyBird0 August 8, 2022 05:12
@aFlyBird0 aFlyBird0 self-assigned this Aug 8, 2022
@aFlyBird0 aFlyBird0 removed their assignment Aug 8, 2022
@aFlyBird0
Copy link
Member

The CI "links when pr" failed because the link https://raw.githubusercontent.com/devstream-io/devstream/main/hack/install/download.sh is on the main branch but the pr has not been merged.

So we could just ignore this CI error. @zhenyuanlau

mkdocs.yml Outdated Show resolved Hide resolved
Signed-off-by: Zhenyuan Lau <zhenyuanlau@outlook.com>
@daniel-hutao daniel-hutao merged commit 7516663 into devstream-io:main Aug 10, 2022
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

Successfully merging this pull request may close these issues.

5 participants