Skip to content

Commit 0ea1dc1

Browse files
committed
Move CONTRIBUTING.md and update all links/refs
1 parent 568ade7 commit 0ea1dc1

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed
File renamed without changes.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ See [./doc/FAQ.md](./doc/FAQ.md).
4747

4848
## Want to help?
4949

50-
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details.
50+
See [CONTRIBUTING](./CONTRIBUTING.md) for details.
5151

5252
## Hiring
5353

ci/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub)
4444
This directory contains scripts used for the development of code-server.
4545

4646
- [./ci/dev/image](./dev/image)
47-
- See [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container.
47+
- See [../CONTRIBUTING.md](../CONTRIBUTING.md) for docs on the development container.
4848
- [./ci/dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`)
4949
- Runs formatters.
5050
- [./ci/dev/lint.sh](./dev/lint.sh) (`yarn lint`)
@@ -60,11 +60,11 @@ This directory contains scripts used for the development of code-server.
6060
- [./ci/dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`)
6161
- Diffs [./lib/vscode](../lib/vscode) into [./ci/dev/vscode.patch](./dev/vscode.patch).
6262
- [./ci/dev/vscode.patch](./dev/vscode.patch)
63-
- Our patch of VS Code, see [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md#vs-code-patch).
63+
- Our patch of VS Code, see [../CONTRIBUTING.md](../CONTRIBUTING.md#vs-code-patch).
6464
- Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch`.
6565
- [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`)
6666
- Starts a process to build and launch code-server and restart on any code changes.
67-
- Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md).
67+
- Example usage in [../CONTRIBUTING.md](../CONTRIBUTING.md).
6868

6969
## build
7070

ci/dev/fmt.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ main() {
2525
doctoc --title '# Setup Guide' doc/guide.md > /dev/null
2626
doctoc --title '# Install' doc/install.md > /dev/null
2727
doctoc --title '# npm Install Requirements' doc/npm.md > /dev/null
28-
doctoc --title '# Contributing' doc/CONTRIBUTING.md > /dev/null
28+
doctoc --title '# Contributing' /CONTRIBUTING.md > /dev/null
2929

3030
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
3131
echo "Files need generation or are formatted incorrectly:"

doc/guide.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
# Setup Guide
44

5-
- [1. Acquire a remote machine](#1-acquire-a-remote-machine)
6-
- [Requirements](#requirements)
7-
- [Google Cloud](#google-cloud)
8-
- [2. Install code-server](#2-install-code-server)
9-
- [3. Expose code-server](#3-expose-code-server)
10-
- [SSH forwarding](#ssh-forwarding)
11-
- [Let's Encrypt](#lets-encrypt)
12-
- [NGINX](#nginx)
13-
- [Self Signed Certificate](#self-signed-certificate)
14-
- [Change the password?](#change-the-password)
15-
- [How do I securely access development web services?](#how-do-i-securely-access-development-web-services)
5+
- [Setup Guide](#setup-guide)
6+
- [1. Acquire a remote machine](#1-acquire-a-remote-machine)
7+
- [Requirements](#requirements)
8+
- [Google Cloud](#google-cloud)
9+
- [2. Install code-server](#2-install-code-server)
10+
- [3. Expose code-server](#3-expose-code-server)
11+
- [SSH forwarding](#ssh-forwarding)
12+
- [Let's Encrypt](#lets-encrypt)
13+
- [NGINX](#nginx)
14+
- [Self Signed Certificate](#self-signed-certificate)
15+
- [Change the password?](#change-the-password)
16+
- [How do I securely access development web services?](#how-do-i-securely-access-development-web-services)
1617

1718
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1819

@@ -24,7 +25,7 @@ Further docs are at:
2425
- [README](../README.md) for a general overview
2526
- [INSTALL](../doc/install.md) for installation
2627
- [FAQ](./FAQ.md) for common questions.
27-
- [CONTRIBUTING](../doc/CONTRIBUTING.md) for development docs
28+
- [CONTRIBUTING](../CONTRIBUTING.md) for development docs
2829

2930
We highly recommend reading the [FAQ](./FAQ.md) on the [Differences compared to VS Code](./FAQ.md#differences-compared-to-vs-code) before beginning.
3031

0 commit comments

Comments
 (0)