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): add uninstall instructions #3840

Merged
merged 1 commit into from
Jul 26, 2021
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Jul 22, 2021

This PR adds an "Uninstall" section to the install.md docs. I decied to add this because I noticed a trend in GitHub Discusions where people have asked how to do this:

Caveat

This does not cover all scenarios but it does cover the ones that have been asked about. I figured we can add more as it gets asked (issue/discussion drive development?).

Todos

@jsjoeio jsjoeio self-assigned this Jul 22, 2021
@jsjoeio jsjoeio added the docs Documentation related label Jul 22, 2021
@jsjoeio jsjoeio added this to the 3.12.0 milestone Jul 22, 2021
docs/install.md Outdated

### install.sh

If you installed with the install script, by default code-server will be in `~/usr/lib/code-server` and you can remove it with `rm -rf`. e.g.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

❓ Is ~/usr/lib/code-server the right path? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

According to install.sh

The release is unarchived into ~/.local/lib/code-server-X.X.X
and the binary symlinked into ~/.local/bin/code-server

So no that is not right.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated for the unarchived. Wondering if we also need to tell them to remove the binary in /bin

@codecov
Copy link

codecov bot commented Jul 22, 2021

Codecov Report

Merging #3840 (4f2fd5a) into main (5b5a1f4) will not change coverage.
The diff coverage is n/a.

❗ Current head 4f2fd5a differs from pull request most recent head 162f70a. Consider uploading reports for the commit 162f70a to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3840   +/-   ##
=======================================
  Coverage   62.60%   62.60%           
=======================================
  Files          36       36           
  Lines        1872     1872           
  Branches      379      379           
=======================================
  Hits         1172     1172           
  Misses        595      595           
  Partials      105      105           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5b5a1f4...162f70a. Read the comment docs.

@jsjoeio jsjoeio marked this pull request as ready for review July 22, 2021 23:18
@jsjoeio jsjoeio requested a review from a team as a code owner July 22, 2021 23:18
docs/install.md Outdated Show resolved Hide resolved
Copy link
Contributor

@GirlBossRush GirlBossRush left a comment

Choose a reason for hiding this comment

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

Some minor nits but otherwise this is a great addition. It would be especially nice if we could follow up with a programmatic means to identify the installation path e.g.

code-server --installation-prefix
code-server --config-prefix

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Jul 26, 2021

code-server --installation-prefix
code-server --config-prefix

I think I understand what you mean, but to be extra clear, you're suggesting adding these as flags/args to run with code-server to identify these things as an end user? Fantastic idea! I'll open a separate issue to document.

@jsjoeio jsjoeio enabled auto-merge July 26, 2021 17:55
@jsjoeio jsjoeio merged commit 3969a39 into main Jul 26, 2021
@jsjoeio jsjoeio deleted the jsjoeio-uninstall-docs branch July 26, 2021 18:11
@jsjoeio jsjoeio modified the milestones: 3.12.0, 3.11.1 Aug 6, 2021
@ahmadyahya11 ahmadyahya11 mentioned this pull request Aug 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants