From 1b288f91e4fc537c2571be42cfd1dbd72f080d23 Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 24 Jun 2021 16:21:28 +0000 Subject: [PATCH 1/5] docs: move README to docs --- README.md => docs/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename README.md => docs/README.md (82%) diff --git a/README.md b/docs/README.md similarity index 82% rename from README.md rename to docs/README.md index 35a1aac8..7c846788 100644 --- a/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. -![Screenshot](./docs/assets/screenshot.png) +![Screenshot](./assets/screenshot.png) ## Highlights @@ -20,14 +20,14 @@ For a good experience, we recommend at least: - 1 GB of RAM - 2 cores -You can use whatever linux distribution floats your boat but in our [guide](./docs/guide.md) we assume Debian on Google Cloud. +You can use whatever linux distribution floats your boat but in our [guide](./guide.md) we assume Debian on Google Cloud. ## Getting Started There are three ways you can 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](./docs/install.md) for instructions applicable to most use cases +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 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: @@ -44,7 +44,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](./docs/guide.md) guide. +We also have an in-depth [setup and configuration](./guide.md) guide. ### code-server --link @@ -62,11 +62,11 @@ Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co ## FAQ -See [./docs/FAQ.md](./docs/FAQ.md). +See [./FAQ.md](./FAQ.md). ## Want to help? -See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details. +See [CONTRIBUTING](./CONTRIBUTING.md) for details. ## Hiring From 2d467b4fbc772f700c30710b59bc6db2ab54bb96 Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 24 Jun 2021 16:55:02 +0000 Subject: [PATCH 2/5] Wrapping the badges on div --- docs/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7c846788..166cbb76 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,12 @@ -# code-server · [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) +# code-server · -[![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) -[![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) +
+ [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) + [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) + [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) + [![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) + [![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) +
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. From 18f90a7832f300a15cfb6c44446e4317d7117f8d Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 24 Jun 2021 16:56:46 +0000 Subject: [PATCH 3/5] Unwrap badges and remove break lines --- docs/README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index 166cbb76..0e720b70 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,6 @@ # code-server · -
- [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) - [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) - [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) - [![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) - [![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) -
+[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) [![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. From 952aafff57da6d65b3705fe87cb950fe01e6c74f Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 24 Jun 2021 17:10:00 +0000 Subject: [PATCH 4/5] Remove dot --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 0e720b70..97f59461 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# code-server · +# code-server [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) [![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) From 010c1d8f2f7750d69679bf546e62f9c3bf87f0e4 Mon Sep 17 00:00:00 2001 From: Bruno Date: Mon, 28 Jun 2021 14:16:20 +0000 Subject: [PATCH 5/5] Fix README path on build-release --- ci/build/build-release.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/build/build-release.sh b/ci/build/build-release.sh index ffad5538..9e04a472 100755 --- a/ci/build/build-release.sh +++ b/ci/build/build-release.sh @@ -22,7 +22,7 @@ main() { bundle_code_server bundle_vscode - rsync README.md "$RELEASE_PATH" + rsync ./docs/README.md "$RELEASE_PATH" rsync LICENSE.txt "$RELEASE_PATH" rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH" }