From 4756257207e5a45edb9a13f80a99f4b8797d9294 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 3 Feb 2021 09:32:35 -0700 Subject: [PATCH 1/5] refactor: rename doc to docs --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- .github/ISSUE_TEMPLATE/extension-request.md | 2 +- .gitignore | 3 ++- .tours/contributing.tour | 10 +++++----- .tours/start-development.tour | 2 +- README.md | 10 +++++----- ci/README.md | 6 +++--- ci/build/npm-postinstall.sh | 2 +- ci/build/release-github-draft.sh | 1 + ci/dev/fmt.sh | 12 ++++++------ {doc => docs}/CONTRIBUTING.md | 0 {doc => docs}/FAQ.md | 0 {doc => docs}/assets/screenshot.png | Bin {doc => docs}/guide.md | 4 ++-- {doc => docs}/install.md | 0 {doc => docs}/ipad.md | 0 {doc => docs}/npm.md | 0 {doc => docs}/triage.md | 0 install.sh | 4 ++-- 19 files changed, 30 insertions(+), 28 deletions(-) rename {doc => docs}/CONTRIBUTING.md (100%) rename {doc => docs}/FAQ.md (100%) rename {doc => docs}/assets/screenshot.png (100%) rename {doc => docs}/guide.md (99%) rename {doc => docs}/install.md (100%) rename {doc => docs}/ipad.md (100%) rename {doc => docs}/npm.md (100%) rename {doc => docs}/triage.md (100%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index a9d70644..f0de7786 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,7 +7,7 @@ assignees: "" --- diff --git a/.gitignore b/.gitignore index 3428cb87..fdb7c563 100644 --- a/.gitignore +++ b/.gitignore @@ -14,4 +14,5 @@ node-* /plugins /lib/coder-cloud-agent .home -coverage \ No newline at end of file +coverage +**/.DS_Store \ No newline at end of file diff --git a/.tours/contributing.tour b/.tours/contributing.tour index 2bece390..1dd8e6b2 100644 --- a/.tours/contributing.tour +++ b/.tours/contributing.tour @@ -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/doc/FAQ.md#heartbeat-file](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#heartbeat-file)" + "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)" }, { "file": "src/node/socket.ts", @@ -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/doc/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/doc/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/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)" }, { "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/doc/FAQ.md#how-do-i-securely-access-web-services](https://github.com/cdr/code-server/blob/master/doc/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/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)" }, { "file": "src/node/proxy.ts", @@ -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/doc/FAQ.md#healthz-endpoint](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#healthz-endpoint)" + "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)" }, { "file": "src/node/routes/login.ts", @@ -145,7 +145,7 @@ { "directory": "lib/vscode", "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/doc/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/cdr/code-server/blob/master/doc/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/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." } ] } \ No newline at end of file diff --git a/.tours/start-development.tour b/.tours/start-development.tour index 41a379ee..4df15077 100644 --- a/.tours/start-development.tour +++ b/.tours/start-development.tour @@ -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/doc/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/cdr/code-server/blob/master/doc/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/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)" } ] } diff --git a/README.md b/README.md index e3b2bef4..a0a5f36b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. -![Screenshot](./doc/assets/screenshot.png) +![Screenshot](./docs/assets/screenshot.png) ## Highlights @@ -17,7 +17,7 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a There are two ways to get started: 1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible) -2. Manually installing code-server; see [Installation](./doc/install.md) for instructions applicable to most use cases +2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases If you choose to use the install script, you can preview what occurs during the install process: @@ -33,7 +33,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](./doc/guide.md) guide. +We also have an in-depth [setup and configuration](./docs/guide.md) guide. ### Cloud Program ☁️ @@ -51,11 +51,11 @@ Proxying code-server to Coder Cloud, you can access your IDE at https://valmar-j ## FAQ -See [./doc/FAQ.md](./doc/FAQ.md). +See [./docs/FAQ.md](./docs/FAQ.md). ## Want to help? -See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details. +See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details. ## Hiring diff --git a/ci/README.md b/ci/README.md index b261a0ff..df8af9f6 100644 --- a/ci/README.md +++ b/ci/README.md @@ -16,7 +16,7 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) 1. Update the version of code-server and make a PR. 1. Update in `package.json` - 2. Update in [./doc/install.md](../doc/install.md) + 2. Update in [./docs/install.md](../docs/install.md) 3. Update in [./ci/helm-chart/README.md](../ci/helm-chart/README.md) - Remember to update the chart version as well on top of appVersion in `Chart.yaml`. - Run `rg -g '!yarn.lock' -g '!*.svg' '3\.7\.5'` to ensure all values have been @@ -62,7 +62,7 @@ NOTE: we have to manually change the color because the default is red if coverag This directory contains scripts used for the development of code-server. - [./ci/dev/image](./dev/image) - - See [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container. + - See [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md) for docs on the development container. - [./ci/dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`) - Runs formatters. - [./ci/dev/lint.sh](./dev/lint.sh) (`yarn lint`) @@ -73,7 +73,7 @@ This directory contains scripts used for the development of code-server. - Runs `yarn fmt`, `yarn lint` and `yarn test`. - [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`) - Starts a process to build and launch code-server and restart on any code changes. - - Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md). + - Example usage in [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md). - [./ci/dev/gen_icons.sh](./ci/dev/gen_icons.sh) (`yarn icons`) - Generates the various icons from a single `.svg` favicon in `src/browser/media/favicon.svg`. diff --git a/ci/build/npm-postinstall.sh b/ci/build/npm-postinstall.sh index b12d9a86..bbe23322 100755 --- a/ci/build/npm-postinstall.sh +++ b/ci/build/npm-postinstall.sh @@ -33,7 +33,7 @@ main() { 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/doc/npm.md" + echo "Please see https://github.com/cdr/code-server/blob/master/docs/npm.md" exit 1 fi } diff --git a/ci/build/release-github-draft.sh b/ci/build/release-github-draft.sh index 4e077a35..1f33c34c 100755 --- a/ci/build/release-github-draft.sh +++ b/ci/build/release-github-draft.sh @@ -20,6 +20,7 @@ maintains all user data in \`~/.local/share/code-server\` so that it is preserve installations. ## New Features + - ⭐ Summarize new features here with references to issues ## Bug Fixes diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index a2bf8032..c01c0deb 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -23,12 +23,12 @@ main() { git ls-files "${prettierExts[@]}" | grep -v "lib/vscode" | grep -v 'helm-chart' ) - doctoc --title '# FAQ' doc/FAQ.md > /dev/null - doctoc --title '# Setup Guide' doc/guide.md > /dev/null - doctoc --title '# Install' doc/install.md > /dev/null - doctoc --title '# npm Install Requirements' doc/npm.md > /dev/null - doctoc --title '# Contributing' doc/CONTRIBUTING.md > /dev/null - doctoc --title '# iPad' doc/ipad.md > /dev/null + doctoc --title '# FAQ' docs/FAQ.md > /dev/null + doctoc --title '# Setup Guide' docs/guide.md > /dev/null + doctoc --title '# Install' docs/install.md > /dev/null + doctoc --title '# npm Install Requirements' docs/npm.md > /dev/null + doctoc --title '# Contributing' docs/CONTRIBUTING.md > /dev/null + doctoc --title '# iPad' docs/ipad.md > /dev/null if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then echo "Files need generation or are formatted incorrectly:" diff --git a/doc/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from doc/CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/doc/FAQ.md b/docs/FAQ.md similarity index 100% rename from doc/FAQ.md rename to docs/FAQ.md diff --git a/doc/assets/screenshot.png b/docs/assets/screenshot.png similarity index 100% rename from doc/assets/screenshot.png rename to docs/assets/screenshot.png diff --git a/doc/guide.md b/docs/guide.md similarity index 99% rename from doc/guide.md rename to docs/guide.md index 3d04dc0c..2e5ebc37 100644 --- a/doc/guide.md +++ b/docs/guide.md @@ -22,9 +22,9 @@ To reiterate, `code-server` lets you run VS Code on a remote server and then acc Further docs are at: - [README](../README.md) for a general overview -- [INSTALL](../doc/install.md) for installation +- [INSTALL](../docs/install.md) for installation - [FAQ](./FAQ.md) for common questions. -- [CONTRIBUTING](../doc/CONTRIBUTING.md) for development docs +- [CONTRIBUTING](../docs/CONTRIBUTING.md) for development docs We highly recommend reading the [FAQ](./FAQ.md) on the [Differences compared to VS Code](./FAQ.md#differences-compared-to-vs-code) before beginning. diff --git a/doc/install.md b/docs/install.md similarity index 100% rename from doc/install.md rename to docs/install.md diff --git a/doc/ipad.md b/docs/ipad.md similarity index 100% rename from doc/ipad.md rename to docs/ipad.md diff --git a/doc/npm.md b/docs/npm.md similarity index 100% rename from doc/npm.md rename to docs/npm.md diff --git a/doc/triage.md b/docs/triage.md similarity index 100% rename from doc/triage.md rename to docs/triage.md diff --git a/install.sh b/install.sh index 9decd53f..bf341cae 100755 --- a/install.sh +++ b/install.sh @@ -2,7 +2,7 @@ set -eu # code-server's automatic install script. -# See https://github.com/cdr/code-server/blob/master/doc/install.md +# See https://github.com/cdr/code-server/blob/master/docs/install.md usage() { arg0="$0" @@ -67,7 +67,7 @@ Usage: It will cache all downloaded assets into ~/.cache/code-server -More installation docs are at https://github.com/cdr/code-server/blob/master/doc/install.md +More installation docs are at https://github.com/cdr/code-server/blob/master/docs/install.md EOF } From a1a0aec4721447c169a884487bee601776c4ca4d Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 3 Feb 2021 09:49:45 -0700 Subject: [PATCH 2/5] Create CODE_OF_CONDUCT.md --- docs/CODE_OF_CONDUCT.md | 76 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 docs/CODE_OF_CONDUCT.md diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..525dc1db --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at joe@coder.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq From d7f67b80dfc514f9a5b1ac57e72a2512c451cdb5 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 3 Feb 2021 09:52:59 -0700 Subject: [PATCH 3/5] chore: add CODE_OF_CONDUCT to fmt script --- ci/dev/fmt.sh | 1 + docs/CODE_OF_CONDUCT.md | 29 ++++++++++++++++------------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index c01c0deb..139c0ea0 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -28,6 +28,7 @@ main() { doctoc --title '# Install' docs/install.md > /dev/null doctoc --title '# npm Install Requirements' docs/npm.md > /dev/null doctoc --title '# Contributing' docs/CONTRIBUTING.md > /dev/null + doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md > /dev/null doctoc --title '# iPad' docs/ipad.md > /dev/null if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 525dc1db..95b8673e 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,3 +1,6 @@ + + + # Contributor Covenant Code of Conduct ## Our Pledge @@ -14,22 +17,22 @@ appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities From 74dc5a881f442c270652e82456af77a34b7978ae Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 3 Feb 2021 11:06:19 -0700 Subject: [PATCH 4/5] refactor: update email address --- docs/CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 95b8673e..c5483f4c 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -58,7 +58,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at joe@coder.com. All +reported by contacting the project team at contact@coder.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. From 43aa0401e064ab4c02f0ff2670a00c6db414fbc3 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 3 Feb 2021 11:08:06 -0700 Subject: [PATCH 5/5] Update docs/CODE_OF_CONDUCT.md --- docs/CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index c5483f4c..fe14b3a6 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -58,7 +58,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at contact@coder.com. All +reported by contacting the project team at opensource@coder.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.