8000 docs: move README to root by jsjoeio · Pull Request #1630 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: move README to root #1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: move README to root
We noticed that when you download the repo as a ZIP from GitHub, it
places the `README.md` in the root, which causes the relative links to
break.

By moving it to the root, this will fix that issue.
  • Loading branch information
jsjoeio committed May 20, 2022
commit 33cf4c9ac4e4db998b3471e4d0f6a8c36399773b
42 changes: 21 additions & 21 deletions docs/README.md → README.md
8000
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=soc

Provision remote development environments with Terraform.

![Kubernetes workspace in Coder v2](./screenshot.png)
![Kubernetes workspace in Coder v2](./docs/screenshot.png)

## Highlights

- Automate development environments for Linux, Windows, and macOS
- Start writing code with a single command
- Get started quickly using one of the [examples](../examples) provided
- Get started quickly using one of the [examples](./examples) provided

## Installing Coder

Expand All @@ -34,7 +34,7 @@ CPU core and 2 GB RAM:
You can set up a temporary deployment, a production deployment, or a system service:

- To set up a **temporary deployment**, start with dev mode (all data is in-memory and is
destroyed on exit):
destroyed on exit):

```bash
coder server --dev
Expand All @@ -48,7 +48,7 @@ destroyed on exit):
```

- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm`
(Fedora, CentOS, RHEL, SUSE):
(Fedora, CentOS, RHEL, SUSE):

```bash
# Edit the configuration!
Expand All @@ -57,7 +57,7 @@ destroyed on exit):
```

> Use `coder --help` to get a complete list of flags and environment
variables.
> variables.

## Creating your first template and workspace

Expand Down Expand Up @@ -95,26 +95,26 @@ coder templates update gcp-linux

## Documentation

- [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)
- [Templates](./templates.md)
- [Manage templates](./templates.md#manage-templates)
- [About Coder](./docs/about.md#about-coder)
- [Why remote development](./docs/about.md#why-remote-development)
- [Why Coder](./docs/about.md#why-coder)
- [What Coder is not](./docs/about.md#what-coder-is-not)
- [Comparison: Coder vs. [product]](./docs/about.md#comparison)
- [Templates](./docs/templates.md)
- [Manage templates](./docs/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)
resources](./docs/templates.md#persistent-and-ephemeral-resources)
- [Parameters](./docs/templates.md#parameters)
- [Workspaces](./docs/workspaces.md)
- [Create workspaces](./docs/workspaces.md#create-workspaces)
- [Connect with SSH](./docs/workspaces.md#connect-with-ssh)
- [Editors and IDEs](./docs/workspaces.md#editors-and-ides)
- [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle)
- [Updating workspaces](./docs/workspaces.md#updating-workspaces)

## Contributing

Read the [contributing docs](./CONTRIBUTING.md).
Read the [contributing docs](./docs/CONTRIBUTING.md).

## Contributors

Expand Down
0