From 8a2f38a74606c04192ccf3f642d845e52157edde Mon Sep 17 00:00:00 2001 From: Kyle Carberry Date: Mon, 18 Mar 2024 14:40:47 +0100 Subject: [PATCH] chore: simplify readme (#12639) * chore: simplify readme Closes #12628. * Add link to module registry --- README.md | 29 +++++++++++------------------ examples/templates/README.md | 4 ---- 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f816b7f1aa..c4ffc5f2e5 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ [Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Enterprise](https://coder.com/docs/v2/latest/enterprise) [![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder) -[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder) [![release](https://img.shields.io/github/v/release/coder/coder)](https://github.com/coder/coder/releases/latest) [![godoc](https://pkg.go.dev/badge/github.com/coder/coder.svg)](https://pkg.go.dev/github.com/coder/coder) [![Go Report Card](https://goreportcard.com/badge/github.com/coder/coder)](https://goreportcard.com/report/github.com/coder/coder) @@ -53,8 +52,8 @@ curl -L https://coder.com/install.sh | sh # Start the Coder server (caches data in ~/.cache/coder) coder server -# Navigate to http://localhost:3000 to create your initial user -# Create a Docker template, and provision a workspace +# Navigate to http://localhost:3000 to create your initial user, +# create a Docker template, and provision a workspace ``` ## Install @@ -68,11 +67,11 @@ Releases. curl -L https://coder.com/install.sh | sh ``` -You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. You can modify the installation process by including flags. Run the install script with `--help` for reference. +You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. Run the install script with `--help` for additional flags. > See [install](https://coder.com/docs/v2/latest/install) for additional methods. -Once installed, you can start a production deployment1 with a single command: +Once installed, you can start a production deployment with a single command: ```shell # Automatically sets up an external access URL on *.try.coder.app @@ -82,8 +81,6 @@ coder server coder server --postgres-url --access-url ``` -> 1 For production deployments, set up an external PostgreSQL instance for reliability. - Use `coder --help` to get a list of flags and environment variables. Use our [install guides](https://coder.com/docs/v2/latest/install) for a full walkthrough. ## Documentation @@ -96,19 +93,13 @@ Browse our docs [here](https://coder.com/docs/v2) or visit a specific section be - [**Administration**](https://coder.com/docs/v2/latest/admin): Learn how to operate Coder - [**Enterprise**](https://coder.com/docs/v2/latest/enterprise): Learn about our paid features built for large teams -## Community and Support +## Support Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request. -[Join our Discord](https://discord.gg/coder) or [Slack](https://cdr.co/join-community) to provide feedback on in-progress features, and chat with the community using Coder! +[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features, and chat with the community using Coder! -## Contributing - -Contributions are welcome! Read the [contributing docs](https://coder.com/docs/v2/latest/CONTRIBUTING) to get started. - -Find our list of contributors [here](https://github.com/coder/coder/graphs/contributors). - -## Related +## Integrations We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories. @@ -116,10 +107,12 @@ We are always working on new integrations. Feel free to open an issue to request - [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click - [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click +- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift +- [**Module Registry**](https://registry.coder.com): Extend development environments with common use-cases +- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs - [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server). ### Community - [**Provision Coder with Terraform**](https://github.com/ElliotG/coder-oss-tf): Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform -- [**Coder GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates -- [**Various Templates**](./examples/templates/community-templates.md): Hetzner Cloud, Docker in Docker, and other templates the community has built. +- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates diff --git a/examples/templates/README.md b/examples/templates/README.md index 3ab46a52ad..bdaaac29ac 100644 --- a/examples/templates/README.md +++ b/examples/templates/README.md @@ -13,7 +13,3 @@ git clone https://github.com/coder/coder cd examples/templates/aws-linux coder templates push ``` - -## Community Templates - -See the list of [Community Templates](./community-templates.md).