-
Notifications
You must be signed in to change notification settings - Fork 795
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
Clean up dependencies in documentation #511
Comments
I do agree we should have minimal deps listed for asdf as the core tool. That said, I do find it difficult myself following the instructions of some plugins as most just defer to the underlying tool's documentation. It is this part of the process that I wish to improve. Ideally, each plugin would have a single code block with a copy button, as we do for the core tools. As an example, I recently received a macOS Mojave machine for work and wanted to use the Python plugin. Not being a macOS user made this more difficult for sure, but the experience was not great. The steps I had to follow were thus:
Now I understand this isn't an issue with the python plugin itself, and that this may be a worst case scenario for a new user on a new OS, but nonetheless, it's not trivial. I would like to come up with some way to make the plugin experience as trivial as the core tool setup experience is becoming (it's not perfect yet). Like I said in the linked PR, I have some ideas. |
I agree with both of you. In my opinion:
Let's keep this issue open for the first point. I just opened a new one for the second, so we can discuss ideas there #512. |
On this topic and in case other find this useful, my plugins (eg
The main motivation was to stop failures on installation leaving a bad state, though I think this can be a better way for people to find the dependencies than what is usually a partial list in the README. |
It seems the "plugin dependencies" section of the installation has been taking as "asdf prerequisite dependencies" and so the Homebrew installation now includes the list of deps too https://github.com/Homebrew/homebrew-core/blob/master/Formula/asdf.rb 😞 Sorry for creating this mess 😅 |
So I believe I have determined out min required git version to be This is due to the use of We use source for dates: search for WORK_TREE in git repo RelNotes: Now we just need to find our min |
I think we should probably be going the other direction here. We should not be listing packages as dependencies of asdf if they are not truly packages it depends on.
curl
andunzip
are currently not required. But neither isunixodbc
I don't think. I think the asdf docs should only list actual dependencies for asdf core. For many of us it doesn't matter, but if someone is using asdf on a low power machine, or in a build, we don't want them installing unnecessary packages. For example, my Lua plugin could be used on very low power machine, and all it requires is a C compiler. Ideally all the user should be instructed to do is install asdf, asdf-lua, and the C compiler.Plugin READMEs should already be specifying all the dependencies they require, and from what I've seen most of them are. (Please create issues on the plugin repos if you see otherwise).
Originally posted by @Stratus3D in #510 (comment)
The text was updated successfully, but these errors were encountered: