docs: Update README to point to code-server docs site #3684
Conversation
Codecov Report
@@ Coverage Diff @@
## main #3684 +/- ##
=======================================
Coverage 59.87% 59.87%
=======================================
Files 35 35
Lines 1797 1797
Branches 364 364
=======================================
Hits 1076 1076
Misses 605 605
Partials 116 116 Continue to review full report at Codecov.
|
docs/README.md
Outdated
| @@ -26,7 +26,7 @@ You can use whatever linux distribution floats your boat but in our [guide](./gu | |||
| There are three ways you can get started: | |||
|
|
|||
| 1. Using the [install script](https://github.com/cdr/code-server/blob/main/install.sh), which automates most of the process. The script uses the system package manager (if possible) | |||
| 2. Manually installing code-server; see [Installation](./install.md) for instructions applicable to most use cases | |||
| 2. Manually installing code-server; see [Installation](https://coder.com/docs/code-server/latest/install) for instructions applicable to most use cases | |||
There was a problem hiding this comment.
@jsjoeio as a part of the release process, do you still do a bulk find and replace to increment the version number in any docs?
If so, I think we should replace latest with the version number in this case actually so that old docs will link to the correct branch.
There was a problem hiding this comment.
Great question! Yes, that happens here.
If so, I think we should replace latest with the version number in this case actually so that old docs will link to the correct branch
Makes sense to me!
There was a problem hiding this comment.
It is quite hard to understand what is happening on this line and when I try to run that locally, after comment the send a PR step, I get an error:
xargs: sd: No such file or directory
There was a problem hiding this comment.
I don't know why sd is being used here... thoughts?
There was a problem hiding this comment.
I changed latest to use 3.10.2 so the current script are able to replace it. I tested it locally.
There was a problem hiding this comment.
Wait a second...I should clarify. You (@BrunoQuaresma) don't need to run that script. That's only used when someone needs to prep a release. I was only pointing that out to show the logic.
All you need to do is update the link Ben pointed out to use the version (3.10.2) (which sounds like you did and tested, thank you
I don't know why sd is being used here... thoughts?
Apologies - I could have sworn I added a check and explanation for it in this file but I guess I forgot. sd is a replacement for sed written in Rust that has a friendly API. See docs.
No description provided.