Skip to content

docs: Update README to point to code-server docs site #3684

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 29, 2021
Merged

docs: Update README to point to code-server docs site #3684

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8256c55
docs: Update README to point to code-server docs site
BrunoQuaresma Jun 28, 2021
008e69f
Update README version
BrunoQuaresma Jun 29, 2021
3856527
Merge branch 'main' of github.com:cdr/code-server into update-docs-links
BrunoQuaresma Jun 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

@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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know why sd is being used here... thoughts?

Copy link
Contributor Author

@BrunoQuaresma BrunoQuaresma Jun 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I changed latest to use 3.10.2 so the current script are able to replace it. I tested it locally.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server) ⚡

If you choose to use the install script, you can preview what occurs during the install process:
Expand All @@ -43,7 +43,7 @@ curl -fsSL https://code-server.dev/install.sh | sh

When done, the install script prints out instructions for running and starting code-server.

We also have an in-depth [setup and configuration](./guide.md) guide.
We also have an in-depth [setup and configuration](https://coder.com/docs/code-server/latest/guide) guide.

### code-server --link

Expand All @@ -61,11 +61,11 @@ Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co

## FAQ

See [./FAQ.md](./FAQ.md).
See [./FAQ.md](https://coder.com/docs/code-server/latest/FAQ).

## Want to help?

See [CONTRIBUTING](./CONTRIBUTING.md) for details.
See [CONTRIBUTING](https://coder.com/docs/code-server/latest/CONTRIBUTING) for details.

## Hiring

Expand Down