Skip to content

Commit 40a7924

Browse files
authored
docs: create dependencies page (#2124)
1 parent 482ea52 commit 40a7924

File tree

5 files changed

+44
-9
lines changed

5 files changed

+44
-9
lines changed

docs/.vitepress/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ const en = [
2525
items: [
2626
{ text: "Configuration", link: "/manage/configuration" },
2727
{ text: "All Commands", link: "/manage/commands" },
28+
{ text: "Dependencies", link: "/manage/dependencies" },
2829
{
2930
text: "Plugin Shortname Index",
3031
link: "https://github.com/asdf-vm/asdf-plugins",

docs/guide/upgrading-to-v0-16.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,8 @@ lines you removed or commented out.
113113
your new asdf installation is working correctly!** After upgrade there are
114114
various files you can remove from the old Bash-script based versions of asdf.
115115
Most of the files in your data directory (typically `~/.asdf/`) can be removed.
116-
The only directories that must be **kept** are:
116+
Note that you don't have to do this. There is no harm in keeping the files from
117+
old versions of asdf around. The only directories that must be **kept** are:
117118

118119
* `downloads/`
119120
* `installs/`

docs/manage/dependencies.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Dependencies
2+
3+
This list is for asdf version 0.16.0 and greater. Older versions of asdf have
4+
additional dependencies.
5+
6+
asdf itself requires the following to be installed:
7+
8+
* Bash version `3.2.48`
9+
* Git version `1.7.7.2`
10+
11+
::: tip Note
12+
13+
Note that asdf plugins may require additional programs to be installed before
14+
they can be used. Read the plugin's documentation and verify you have all of
15+
the plugin's dependencies installed before installing it.
16+
17+
:::
18+
19+
## Install
20+
21+
If you need to manually install dependencies for asdf run the command for your
22+
OS below.
23+
24+
<!--@include: @/parts/install-dependencies-cmds.md-->
25+
26+
::: tip Note
27+
28+
`sudo` may be required depending on your system configuration.
29+
30+
:::
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
| OS | Package Manager | Command |
2+
| ----- | --------------- | ---------------------------------- |
3+
| linux | Aptitude | `apt install git bash` |
4+
| linux | DNF | `dnf install git bash` |
5+
| linux | Pacman | `pacman -S git bash` |
6+
| linux | Zypper | `zypper install git bash` |
7+
| macOS | Homebrew | `brew install coreutils git bash` |
8+
| macOS | Spack | `spack install coreutils git bash` |

docs/parts/install-dependencies.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,12 @@
22

33
asdf primarily requires `git`. Here is a _non-exhaustive_ list of commands to run for _your_ package manager (some might automatically install these tools in later steps).
44

5-
| OS | Package Manager | Command |
6-
| ----- | --------------- | ---------------------------------- |
7-
| linux | Aptitude | `apt install git` |
8-
| linux | DNF | `dnf install git` |
9-
| linux | Pacman | `pacman -S git` |
10-
| linux | Zypper | `zypper install git` |
11-
| macOS | Homebrew | `brew install coreutils git` |
12-
| macOS | Spack | `spack install coreutils git` |
5+
<!--@include: @/parts/install-dependencies-cmds.md-->
136

147
::: tip Note
158

169
`sudo` may be required depending on your system configuration.
1710

1811
:::
12+
13+
Please see the [Dependencies page](/manage/dependencies) for more information.

0 commit comments

Comments
 (0)