add documentation explaining how to uninstall (#1954)

* add documentation explaining how to uninstall

There's good docs on how to install dep, but we're missing docs on how
to uninstall dep. This adds them. I thought about adding some text to
the top-level README.md file but figured uninstalling dep wasn't a vital
topic for top-level docs and that a separate doc in the docs/ tree was
more than enough.

Issue #1953

* Link in the uninstalling doc from the install doc page

* Aha, figured out how to add the uninstalling.md link in the docs site
This commit is contained in:
Jay Pipes 2018-07-24 12:14:41 -04:00 коммит произвёл Carolyn Van Slyck
Родитель a9121da2d3
Коммит aefa7cce14
3 изменённых файлов: 40 добавлений и 1 удалений

Просмотреть файл

@ -56,3 +56,7 @@ go get -u github.com/golang/dep/cmd/dep
```
Note that dep requires a functioning Go workspace and GOPATH. If you're unfamiliar with Go workspaces and GOPATH, have a look at [the language documentation](https://golang.org/doc/code.html#Organization) and get your local workspace set up. Dep's model could lead to being able to work without GOPATH, but we're not there yet.
## Uninstalling
Looking for a way to uninstall `dep`? There's a separate [doc page](uninstalling.md) for that!

35
docs/uninstalling.md Normal file
Просмотреть файл

@ -0,0 +1,35 @@
---
title: Uninstalling Dep
---
## Uninstalling
To uninstall `dep` itself, follow these instructions, depending on how you installed `dep` originally.
### If you installed `dep` by executing the `install.sh` script via curl
If you installed `dep` using the `install.sh` script, it is safe to simply delete the installed binary file.
On Linux and MacOS, the `install.sh` script installs a pre-compiled binary to `$GOPATH/bin/dep`. It is safe to simply `rm` the installed `$GOPATH/bin/dep` file:
```sh
$ rm $GOPATH/bin/dep
```
On Windows, the `install.sh` script installs a pre-compiled binary to `$GOPATH/bin/dep.exe`. It is safe to simply delete this file to uninstall `dep`.
### If you installed `dep` using Homebrew on MacOS
If you installed `dep` using Homebrew on MacOS, uninstall `dep` also using Homebrew:
```sh
$ brew uninstall dep
```
### If you installed `dep` using `pacman` on Arch Linux
If you installed `dep` using `pacman` on Arch Linux, uninstall `dep` like so:
```sh
$ pacman -R dep
```

Просмотреть файл

@ -1,6 +1,6 @@
{
"docs": {
"Guides": ["introduction", "installation", "new-project", "migrating", "daily-dep"],
"Guides": ["introduction", "installation", "new-project", "migrating", "daily-dep", "uninstalling"],
"References": ["ensure-mechanics", "failure-modes", "the-solver", "deduction", "Gopkg.toml", "Gopkg.lock", "FAQ", "env-vars", "glossary"]
}
}