Skip to content

docs: Update some more links #4806

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

Merged
merged 7 commits into from
Feb 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
# NOTE@jsjoeio
# disabling this until we can audit the build process
# and the usefulness of this step
# See: https://github.com/cdr/code-server/issues/4287
# See: https://github.com/coder/code-server/issues/4287
# - name: Fetch dependencies from cache
# id: cache-yarn
# uses: actions/cache@v2
Expand Down
10 changes: 5 additions & 5 deletions .tours/contributing.tour
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
{
"file": "src/node/heart.ts",
"line": 7,
"description": "code-server's heart beats to indicate recent activity.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#heartbeat-file](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#heartbeat-file)"
"description": "code-server's heart beats to indicate recent activity.\n\nAlso documented here: [https://github.com/coder/code-server/blob/master/docs/FAQ.md#heartbeat-file](https://github.com/coder/code-server/blob/master/docs/FAQ.md#heartbeat-file)"
},
{
"file": "src/node/socket.ts",
Expand Down Expand Up @@ -80,12 +80,12 @@
{
"file": "src/node/routes/domainProxy.ts",
"line": 18,
"description": "code-server provides a built-in proxy to help in developing web-based applications. This is the code for the domain-based proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
"description": "code-server provides a built-in proxy to help in developing web-based applications. This is the code for the domain-based proxy.\n\nAlso documented here: [https://github.com/coder/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/coder/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
},
{
"file": "src/node/routes/pathProxy.ts",
"line": 19,
"description": "Here is the path-based version of the proxy.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
"description": "Here is the path-based version of the proxy.\n\nAlso documented here: [https://github.com/coder/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/coder/code-server/blob/master/docs/FAQ.md#how-do-i-securely-access-web-services)"
},
{
"file": "src/node/proxy.ts",
Expand All @@ -95,7 +95,7 @@
{
"file": "src/node/routes/health.ts",
"line": 5,
"description": "A simple endpoint that lets you see if code-server is up.\n\nAlso documented here: [https://github.com/cdr/code-server/blob/master/docs/FAQ.md#healthz-endpoint](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#healthz-endpoint)"
"description": "A simple endpoint that lets you see if code-server is up.\n\nAlso documented here: [https://github.com/coder/code-server/blob/master/docs/FAQ.md#healthz-endpoint](https://github.com/coder/code-server/blob/master/docs/FAQ.md#healthz-endpoint)"
},
{
"file": "src/node/routes/login.ts",
Expand Down Expand Up @@ -145,7 +145,7 @@
{
"directory": "vendor/modules/code-oss-dev",
"line": 1,
"description": "code-server makes use of VS Code's frontend web/remote support. Most of the modifications implement the remote server since that portion of the code is closed source and not released with VS Code.\n\nWe also have a few bug fixes and have added some features (like client-side extensions). See [https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code) for a list.\n\nWe make an effort to keep the modifications as few as possible."
"description": "code-server makes use of VS Code's frontend web/remote support. Most of the modifications implement the remote server since that portion of the code is closed source and not released with VS Code.\n\nWe also have a few bug fixes and have added some features (like client-side extensions). See [https://github.com/coder/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/coder/code-server/blob/master/docs/CONTRIBUTING.md#modifications-to-vs-code) for a list.\n\nWe make an effort to keep the modifications as few as possible."
}
]
}
2 changes: 1 addition & 1 deletion .tours/start-development.tour
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
{
"file": "src/node/app.ts",
"line": 62,
"description": "## That's it!\n\n\nThat's all there is to it! When this tour ends, your terminal session may stop, but just use `yarn watch` to start developing from here on out!\n\n\nIf you haven't already, be sure to check out these resources:\n- [Tour: Contributing](command:codetour.startTourByTitle?[\"Contributing\")\n- [Docs: FAQ.md](https://github.com/cdr/code-server/blob/master/docs/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/cdr/code-server/blob/master/docs/CONTRIBUTING.md)\n- [Community: GitHub Discussions](https://github.com/cdr/code-server/discussions)\n- [Community: Slack](https://community.coder.com)"
"description": "## That's it!\n\n\nThat's all there is to it! When this tour ends, your terminal session may stop, but just use `yarn watch` to start developing from here on out!\n\n\nIf you haven't already, be sure to check out these resources:\n- [Tour: Contributing](command:codetour.startTourByTitle?[\"Contributing\")\n- [Docs: FAQ.md](https://github.com/coder/code-server/blob/master/docs/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/coder/code-server/blob/master/docs/CONTRIBUTING.md)\n- [Community: GitHub Discussions](https://github.com/coder/code-server/discussions)\n- [Community: Slack](https://community.coder.com)"
}
]
}
20 changes: 10 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ VS Code v99.99.999

-->

## [Unreleased](https://github.com/cdr/code-server/releases)
## [Unreleased](https://github.com/coder/code-server/releases)

VS Code v0.00.0

### Changed

- Add here

## [4.0.2](https://github.com/cdr/code-server/releases/tag/v4.0.2) - 2022-01-27
## [4.0.2](https://github.com/coder/code-server/releases/tag/v4.0.2) - 2022-01-27

VS Code v1.63.0

Expand All @@ -39,7 +39,7 @@ VS Code v1.63.0
file is missing. While we do include the script now we are leaving the
variable omitted because the script does not work yet.

## [4.0.1](https://github.com/cdr/code-server/releases/tag/v4.0.1) - 2022-01-04
## [4.0.1](https://github.com/coder/code-server/releases/tag/v4.0.1) - 2022-01-04

VS Code v1.63.0

Expand Down Expand Up @@ -77,7 +77,7 @@ implementation (#4414).

- We fixed a XSS vulnerability by escaping HTML from messages in the error page (#4430).

## [3.12.0](https://github.com/cdr/code-server/releases/tag/v3.12.0) - 2021-09-15
## [3.12.0](https://github.com/coder/code-server/releases/tag/v3.12.0) - 2021-09-15

VS Code v1.60.0

Expand All @@ -89,15 +89,15 @@ VS Code v1.60.0

- Fix logout when using a base path (#3608).

## [3.11.1](https://github.com/cdr/code-server/releases/tag/v3.11.1) - 2021-08-06
## [3.11.1](https://github.com/coder/code-server/releases/tag/v3.11.1) - 2021-08-06

Undocumented (see releases page).

## [3.11.0](https://github.com/cdr/code-server/releases/tag/v3.11.0) - 2021-06-14
## [3.11.0](https://github.com/coder/code-server/releases/tag/v3.11.0) - 2021-06-14

Undocumented (see releases page).

## [3.10.2](https://github.com/cdr/code-server/releases/tag/v3.10.2) - 2021-05-21
## [3.10.2](https://github.com/coder/code-server/releases/tag/v3.10.2) - 2021-05-21

VS Code v1.56.1

Expand All @@ -113,7 +113,7 @@ VS Code v1.56.1

- Fix "Open Folder" on welcome page (#3437).

## [3.10.1](https://github.com/cdr/code-server/releases/tag/v3.10.1) - 2021-05-17
## [3.10.1](https://github.com/coder/code-server/releases/tag/v3.10.1) - 2021-05-17

VS Code v1.56.1

Expand All @@ -127,7 +127,7 @@ VS Code v1.56.1

- Use xdgBasedir.runtime instead of tmp (#3304).

## [3.10.0](https://github.com/cdr/code-server/releases/tag/v3.10.0) - 2021-05-10
## [3.10.0](https://github.com/coder/code-server/releases/tag/v3.10.0) - 2021-05-10

VS Code v1.56.0

Expand Down Expand Up @@ -158,4 +158,4 @@ VS Code v1.56.0
This was added with `3.10.0`, which means any previous versions are not
documented in the changelog.

To see those, please visit the [Releases page](https://github.com/cdr/code-server/releases).
To see those, please visit the [Releases page](https://github.com/coder/code-server/releases).
2 changes: 1 addition & 1 deletion ci/build/build-code-server.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ main() {
echo "Downloading the cloud agent..."

set +e
curl -fsSL "https://github.com/cdr/cloud-agent/releases/latest/download/cloud-agent-$OS-$ARCH" -o ./lib/coder-cloud-agent
curl -fsSL "https://github.com/coder/cloud-agent/releases/latest/download/cloud-agent-$OS-$ARCH" -o ./lib/coder-cloud-agent
chmod +x ./lib/coder-cloud-agent
set -e
fi
Expand Down
4 changes: 2 additions & 2 deletions ci/build/code-server.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ set -eu
# Runs code-server with the bundled node binary.

_realpath() {
# See https://github.com/cdr/code-server/issues/1537 on why no realpath or readlink -f.
# See https://github.com/coder/code-server/issues/1537 on why no realpath or readlink -f.

script="$1"
cd "$(dirname "$script")"
Expand All @@ -16,7 +16,7 @@ _realpath() {
&& cat package.json | grep -q '^ "name": "code-server",$'; then
echo "***** Please use the script in bin/code-server instead!" >&2
echo "***** This script will soon be removed!" >&2
echo "***** See the release notes at https://github.com/cdr/code-server/releases/tag/v3.4.0" >&2
echo "***** See the release notes at https://github.com/coder/code-server/releases/tag/v3.4.0" >&2
fi

script="$(readlink "$(basename "$script")")"
Expand Down
2 changes: 1 addition & 1 deletion ci/build/nfpm.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ maintainer: "Anmol Sethi <hi@nhooyr.io>"
description: |
Run VS Code in the browser.
vendor: "Coder"
homepage: "https://github.com/cdr/code-server"
homepage: "https://github.com/coder/code-server"
license: "MIT"

contents:
Expand Down
4 changes: 2 additions & 2 deletions ci/build/npm-postinstall.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ main() {

mkdir -p ./lib

if curl -fsSL "https://github.com/cdr/cloud-agent/releases/latest/download/cloud-agent-$OS-$ARCH" -o ./lib/coder-cloud-agent; then
if curl -fsSL "https://github.com/coder/cloud-agent/releases/latest/download/cloud-agent-$OS-$ARCH" -o ./lib/coder-cloud-agent; then
chmod +x ./lib/coder-cloud-agent
else
echo "Failed to download cloud agent; --link will not work"
fi

if ! vscode_yarn; then
echo "You may not have the required dependencies to build the native modules."
echo "Please see https://github.com/cdr/code-server/blob/master/docs/npm.md"
echo "Please see https://github.com/coder/code-server/blob/master/docs/npm.md"
exit 1
fi

Expand Down
2 changes: 1 addition & 1 deletion ci/build/release-prep.sh
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ main() {

echo -e "\nOpening a draft PR on GitHub"
# To read about these flags, visit the docs: https://cli.github.com/manual/gh_pr_create
$CMD gh pr create --base main --title "release: $CODE_SERVER_VERSION_TO_UPDATE" --body "$RELEASE_TEMPLATE_STRING" --reviewer @cdr/code-server-reviewers --repo cdr/code-server --draft --assignee "@me"
$CMD gh pr create --base main --title "release: $CODE_SERVER_VERSION_TO_UPDATE" --body "$RELEASE_TEMPLATE_STRING" --reviewer @coder/code-server-reviewers --repo coder/code-server --draft --assignee "@me"

# Open PR in browser
$CMD gh pr view --web
Expand Down
2 changes: 1 addition & 1 deletion ci/helm-chart/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: code-server
description: A Helm chart for cdr/code-server
description: A Helm chart for coder/code-server

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
10 changes: 5 additions & 5 deletions ci/steps/brew-bump.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ main() {
exit 1
fi

# NOTE: we need to make sure cdrci/homebrew-core
# NOTE: we need to make sure coderci/homebrew-core
# is up-to-date
# otherwise, brew bump-formula-pr will use an
# outdated base
echo "Cloning cdrci/homebrew-core"
git clone https://github.com/cdrci/homebrew-core.git
echo "Cloning coderci/homebrew-core"
git clone https://github.com/coderci/homebrew-core.git

# Make sure the git clone step is successful
if directory_exists "homebrew-core"; then
Expand Down Expand Up @@ -57,7 +57,7 @@ main() {
echo "Merging in latest Homebrew/homebrew-core changes"
git merge upstream/master

echo "Pushing changes to cdrci/homebrew-core fork on GitHub"
echo "Pushing changes to coderci/homebrew-core fork on GitHub"

# GIT_ASKPASS lets us use the password when pushing without revealing it in the process list
# See: https://serverfault.com/a/912788
Expand Down Expand Up @@ -86,7 +86,7 @@ main() {
# Export the variables so git sees them
export HOMEBREW_GITHUB_API_TOKEN="$HOMEBREW_GITHUB_API_TOKEN"
export GIT_ASKPASS="$PATH_TO_ASKPASS"
git push https://cdr-oss@github.com/cdr-oss/homebrew-core.git --all
git push https://coder-oss@github.com/coder-oss/homebrew-core.git --all

# Find the docs for bump-formula-pr here
# https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-cmd/bump-formula-pr.rb#L18
Expand Down
2 changes: 1 addition & 1 deletion ci/steps/publish-npm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ main() {
tar -xzf release-npm-package/package.tar.gz

# Ignore symlink when publishing npm package
# See: https://github.com/cdr/code-server/pull/3935
# See: https://github.com/coder/code-server/pull/3935
echo "node_modules.asar" > release/.npmignore

# NOTES:@jsjoeio
Expand Down
14 changes: 7 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ These are required by VS Code. See [their Wiki](https://github.com/microsoft/vsc

## Creating pull requests

Please create a [GitHub Issue](https://github.com/cdr/code-server/issues) that
Please create a [GitHub Issue](https://github.com/coder/code-server/issues) that
includes context for issues that you see. You can skip this if the proposed fix
is minor.

Expand All @@ -78,12 +78,12 @@ we'll guide you.

## Development workflow

The current development workflow is a bit tricky because we have this repo and we use our `cdr/vscode` fork inside it with [`yarn link`](https://classic.yarnpkg.com/lang/en/docs/cli/link/).
The current development workflow is a bit tricky because we have this repo and we use our `coder/vscode` fork inside it with [`yarn link`](https://classic.yarnpkg.com/lang/en/docs/cli/link/).

Here are these steps you should follow to get your dev environment setup:

1. `git clone https://github.com/cdr/code-server.git` - Clone `code-server`
2. `git clone https://github.com/cdr/vscode.git` - Clone `vscode`
1. `git clone https://github.com/coder/code-server.git` - Clone `code-server`
2. `git clone https://github.com/coder/vscode.git` - Clone `vscode`
3. `cd vscode && yarn install` - install the dependencies in the `vscode` repo
4. `cd code-server && yarn install` - install the dependencies in the `code-server` repo
5. `cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package)
Expand All @@ -92,14 +92,14 @@ Here are these steps you should follow to get your dev environment setup:

### Updates to VS Code

If changes are made and merged into `main` in the [`cdr/vscode`](https://github.com/cdr/vscode) repo, then you'll need to update the version in the `code-server` repo by following these steps:
If changes are made and merged into `main` in the [`coder/vscode`](https://github.com/coder/vscode) repo, then you'll need to update the version in the `code-server` repo by following these steps:

1. Update the package tag listed in `vendor/package.json`:

```json
{
"devDependencies": {
"vscode": "cdr/vscode#<latest-commit-sha>"
"vscode": "coder/vscode#<latest-commit-sha>"
}
}
```
Expand Down Expand Up @@ -148,7 +148,7 @@ yarn package

### Help

If you get stuck or need help, you can always start a new GitHub Discussion [here](https://github.com/cdr/code-server/discussions). One of the maintainers will respond and help you out.
If you get stuck or need help, you can always start a new GitHub Discussion [here](https://github.com/coder/code-server/discussions). One of the maintainers will respond and help you out.

## Test

Expand Down
16 changes: 8 additions & 8 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
## Questions?

Please file all questions and support requests at
<https://github.com/cdr/code-server/discussions>.
<https://github.com/coder/code-server/discussions>.

## How should I expose code-server to the internet?

Expand Down Expand Up @@ -111,11 +111,11 @@ These are the closed-source extensions that are presently unavailable:

1. [Live Share](https://visualstudio.microsoft.com/services/live-share). We may
implement something similar (see
[#33](https://github.com/cdr/code-server/issues/33))
[#33](https://github.com/coder/code-server/issues/33))
1. [Remote Extensions (SSH, Containers,
WSL)](https://github.com/microsoft/vscode-remote-release). We may implement
these again at some point, see
([#1315](https://github.com/cdr/code-server/issues/1315)).
([#1315](https://github.com/coder/code-server/issues/1315)).

For more about the closed source portions of VS Code, see [vscodium/vscodium](https://github.com/VSCodium/vscodium#why-does-this-exist).

Expand Down Expand Up @@ -222,7 +222,7 @@ You may have to give Node.js full disk access, since it doesn't implement any of
Privacy** > **Privacy** > **Full Disk Access**. Then, click the 🔒 to unlock,
click **+**, and select the Node.js binary you located in the previous step.

See [#2794](https://github.com/cdr/code-server/issues/2794) for additional context.
See [#2794](https://github.com/coder/code-server/issues/2794) for additional context.

## How do I direct server-side requests through a proxy?

Expand Down Expand Up @@ -302,7 +302,7 @@ after a predetermined amount of time, you can do so by checking continuously for
the last modified time on the heartbeat file. If it is older than X minutes (or
whatever amount of time you'd like), you can kill code-server.

Eventually, [#1636](https://github.com/cdr/code-server/issues/1636) will make
Eventually, [#1636](https://github.com/coder/code-server/issues/1636) will make
this process better.

## How do I change the password?
Expand Down Expand Up @@ -376,7 +376,7 @@ Theia doesn't allow you to reuse your existing VS Code config.
## What's the difference between code-server and OpenVSCode-Server?

code-server and OpenVSCode-Server both allow you to access VS Code via a
browser. The two projects also use their own [forks of VS Code](https://github.com/cdr/vscode) to
browser. The two projects also use their own [forks of VS Code](https://github.com/coder/vscode) to
leverage modern VS Code APIs and stay up to date with the upsteam version.

However, OpenVSCode-Server is scoped at only making VS Code available in the web browser.
Expand All @@ -388,7 +388,7 @@ code-server includes some other features:
- plugin API
- settings sync (coming soon)

For more details, see [this discussion post](https://github.com/cdr/code-server/discussions/4267#discussioncomment-1411583).
For more details, see [this discussion post](https://github.com/coder/code-server/discussions/4267#discussioncomment-1411583).

## What's the difference between code-server and GitHub Codespaces?

Expand All @@ -406,7 +406,7 @@ minute plus an additional twelve per hour.

## Are there community projects involving code-server?

Visit the [awesome-code-server](https://github.com/cdr/awesome-code-server)
Visit the [awesome-code-server](https://github.com/coder/awesome-code-server)
repository to view community projects and guides with code-server! Feel free to
add your own!

Expand Down
Loading