From 1c0f53cb0fe6c514a7619f44b824854fb93a1d26 Mon Sep 17 00:00:00 2001 From: Bruno Date: Tue, 7 Jun 2022 16:46:04 +0000 Subject: [PATCH 1/7] chore: Update docs manifest home page and icons --- README.md => docs/README.md | 0 docs/manifest.json | 24 +++++++++++++++++------- 2 files changed, 17 insertions(+), 7 deletions(-) rename README.md => docs/README.md (100%) diff --git a/README.md b/docs/README.md similarity index 100% rename from README.md rename to docs/README.md diff --git a/docs/manifest.json b/docs/manifest.json index fae42e290df52..1099266476b7e 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,30 +1,40 @@ { "versions": ["0.6.2"], "routes": [ + { + "title": "Home", + "description": "Learn how to install and run Coder.", + "path": "./README.md", + "icon": "" + }, { "title": "About", "description": "About Coder", - "path": "./about.md" + "path": "./about.md", + "icon": "" }, { "title": "Installation", "description": "Learn how to install and deploy Coder.", + "icon": "", "path": "./install.md" }, { "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces.", "path": "./templates.md", - "icon": "" + "icon": "" }, { "title": "Workspaces", "description": "Learn about Coder workspaces.", + "icon": "\n\n\n", "path": "./workspaces.md" }, { "title": "Contributing", "description": "Learn how to contribute to Coder.", + "icon": "", "path": "./CONTRIBUTING.md", "children": [ { @@ -36,13 +46,13 @@ "title": "Contributors", "description": "See a contributors to Coder.", "path": "./CONTRIBUTORS.md" + }, + { + "title": "Security policy", + "description": "Learn how to report vulnerabilities in Coder.", + "path": "./SECURITY.md" } ] - }, - { - "title": "Security policy", - "description": "Learn how to report vulnerabilities in Coder.", - "path": "./SECURITY.md" } ] } From ffd800f144bd6c13b2ee87ab1f839ebf7f54c079 Mon Sep 17 00:00:00 2001 From: Bruno Date: Tue, 7 Jun 2022 16:50:59 +0000 Subject: [PATCH 2/7] RRemove contributors --- docs/manifest.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 1099266476b7e..8d1a8f2dee316 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -42,11 +42,6 @@ "description": "See the code of conduct for contributing to Coder.", "path": "./CODE_OF_CONDUCT.md" }, - { - "title": "Contributors", - "description": "See a contributors to Coder.", - "path": "./CONTRIBUTORS.md" - }, { "title": "Security policy", "description": "Learn how to report vulnerabilities in Coder.", From 2082bb065d57112dd40d2bb4adb0d91a6c4fff7f Mon Sep 17 00:00:00 2001 From: Bruno Date: Tue, 7 Jun 2022 16:53:47 +0000 Subject: [PATCH 3/7] Update template icon --- docs/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index 8d1a8f2dee316..2092f54fb135d 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -23,7 +23,7 @@ "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces.", "path": "./templates.md", - "icon": "" + "icon": " " }, { "title": "Workspaces", From f4a061fd4b204503c7fd6eb9fce10202b939898c Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 9 Jun 2022 18:19:11 +0000 Subject: [PATCH 4/7] fixup: manifest.json changes --- docs/manifest.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 2092f54fb135d..fcf582372cc51 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -3,7 +3,7 @@ "routes": [ { "title": "Home", - "description": "Learn how to install and run Coder.", + "description": "How to install and run Coder", "path": "./README.md", "icon": "" }, @@ -15,7 +15,7 @@ }, { "title": "Installation", - "description": "Learn how to install and deploy Coder.", + "description": "How to install and deploy Coder", "icon": "", "path": "./install.md" }, @@ -44,7 +44,7 @@ }, { "title": "Security policy", - "description": "Learn how to report vulnerabilities in Coder.", + "description": "How to report vulnerabilities in Coder", "path": "./SECURITY.md" } ] From 06f0568e23c45d0b1801f16c5cbe96e7348d7aa2 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 9 Jun 2022 18:26:19 +0000 Subject: [PATCH 5/7] fix: add missing readme to root --- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000000..30f11fa570ffc --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Coder + +[!["GitHub +Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions) +[!["Join us on +Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=purple)](https://discord.gg/coder) +[![Twitter +Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) +[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder) + +Coder creates remote development machines so your team can develop from anywhere. + +

+ +

+ +**Manage less** + +- Ensure your entire team is using the same tools and resources + - Rollout critical updates to your developers with one command +- Automatically shut down expensive cloud resources +- Keep your source code and data behind your firewall + +**Code more** + +- Build and test faster + - Leveraging cloud CPUs, RAM, network speeds, etc. +- Access your environment from any place on any client (even an iPad) +- Onboard instantly then stay up to date continuously + +## Getting Started + +> **Note**: +> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new). + +There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux). + +If you use the install script, you can preview what occurs during the install process: + +```sh +curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run +``` + +To install, run: + +```sh +curl -fsSL https://coder.com/install.sh | sh +``` + +Once installed, you can run a temporary deployment in dev mode (all data is in-memory and destroyed on exit): + +```sh +coder server --dev +``` + +Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough. + +## Documentation + +Visit our docs [here](./docs/index.md). + +## Comparison + +Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not). + +| Tool | Type | Delivery Model | Cost | Environments | +| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 | +| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 | +| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers | +| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux containers | + +--- + +_Last updated: 5/27/22_ + +## Community and Support + +Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)! + +[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) + +## Contributing + +Read the [contributing docs](./docs/CONTRIBUTING.md). + +Find our list of contributors [here](./docs/CONTRIBUTORS.md). From ec932751694dae7c55d7291c2080480dc6115822 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 9 Jun 2022 18:26:41 +0000 Subject: [PATCH 6/7] fix: add readme to /docs with toc --- docs/README.md | 110 +++++++++++-------------------------------------- 1 file changed, 23 insertions(+), 87 deletions(-) diff --git a/docs/README.md b/docs/README.md index 30f11fa570ffc..e01b58e5fa0d8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,87 +1,23 @@ -# Coder - -[!["GitHub -Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions) -[!["Join us on -Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=purple)](https://discord.gg/coder) -[![Twitter -Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) -[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder) - -Coder creates remote development machines so your team can develop from anywhere. - -

- -

- -**Manage less** - -- Ensure your entire team is using the same tools and resources - - Rollout critical updates to your developers with one command -- Automatically shut down expensive cloud resources -- Keep your source code and data behind your firewall - -**Code more** - -- Build and test faster - - Leveraging cloud CPUs, RAM, network speeds, etc. -- Access your environment from any place on any client (even an iPad) -- Onboard instantly then stay up to date continuously - -## Getting Started - -> **Note**: -> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new). - -There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux). - -If you use the install script, you can preview what occurs during the install process: - -```sh -curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run -``` - -To install, run: - -```sh -curl -fsSL https://coder.com/install.sh | sh -``` - -Once installed, you can run a temporary deployment in dev mode (all data is in-memory and destroyed on exit): - -```sh -coder server --dev -``` - -Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough. - -## Documentation - -Visit our docs [here](./docs/index.md). - -## Comparison - -Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not). - -| Tool | Type | Delivery Model | Cost | Environments | -| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 | -| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 | -| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers | -| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux containers | - ---- - -_Last updated: 5/27/22_ - -## Community and Support - -Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)! - -[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) - -## Contributing - -Read the [contributing docs](./docs/CONTRIBUTING.md). - -Find our list of contributors [here](./docs/CONTRIBUTORS.md). +# Coder Documentation + +## Table of Contents + +- [About Coder](./about.md#about-coder) + - [Why remote development](./about.md#why-remote-development) + - [Why Coder](./about.md#why-coder) + - [What Coder is not](./about.md#what-coder-is-not) + - [Comparison: Coder vs. [product]](./about.md#comparison) +- [Quickstart](./quickstart.md) + - [Creating your first template and workspace](./quickstart.md#creating-your-first-template-and-workspace) + - [Modifying templates](./quickstart.md#modifying-templates) +- [Templates](./templates.md) + - [Manage templates](./templates.md#manage-templates) + - [Persistent and ephemeral + resources](./templates.md#persistent-and-ephemeral-resources) + - [Parameters](./templates.md#parameters) +- [Workspaces](./workspaces.md) + - [Create workspaces](./workspaces.md#create-workspaces) + - [Connect with SSH](./workspaces.md#connect-with-ssh) + - [Editors and IDEs](./workspaces.md#editors-and-ides) + - [Workspace lifecycle](./workspaces.md#workspace-lifecycle) + - [Updating workspaces](./workspaces.md#updating-workspaces) From 3bb352761b316739e5fd51deaabf7f578017cf69 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 9 Jun 2022 18:26:49 +0000 Subject: [PATCH 7/7] fix: add quickstart to manifest --- docs/manifest.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/manifest.json b/docs/manifest.json index fcf582372cc51..b75b003dc5711 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -19,6 +19,12 @@ "icon": "", "path": "./install.md" }, + { + "title": "Quickstart", + "description": "Create your first template and workspace", + "icon": "", + "path": "./quickstart.md" + }, { "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces.",