Skip to content

feat: initial docs pages #1107

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.

Sign up for GitHub

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 34 commits into from
Apr 26, 2022
Merged

feat: initial docs pages #1107

Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
eba2d48
docs structure and edits to getting started
bpmct Apr 22, 2022
1283422
draft for about page
bpmct Apr 22, 2022
8cb6a88
skeleton for concepts page
bpmct Apr 22, 2022
4c1b767
attempt at explaining templates
bpmct Apr 24, 2022
d5f5116
left-align tables
bpmct Apr 24, 2022
de9f3af
add best practices and variables
bpmct Apr 24, 2022
892122c
update structrure
bpmct Apr 25, 2022
c526982
update structure
bpmct Apr 25, 2022
68da32e
templates are shared
bpmct Apr 25, 2022
808767e
workspaces docs
bpmct Apr 25, 2022
c8f1e25
remove coming soon
bpmct Apr 25, 2022
a803f8a
fix typos
bpmct Apr 25, 2022
1bb34bd
docs structure and edits to getting started
bpmct Apr 22, 2022
97f03e0
draft for about page
bpmct Apr 22, 2022
0485c6c
skeleton for concepts page
bpmct Apr 22, 2022
0e1bc57
attempt at explaining templates
bpmct Apr 24, 2022
57d4d0f
left-align tables
bpmct Apr 24, 2022
fc48d53
add best practices and variables
bpmct Apr 24, 2022
361decc
update structrure
bpmct Apr 25, 2022
950ee85
update structure
bpmct Apr 25, 2022
afac7ee
templates are shared
bpmct Apr 25, 2022
e67dabb
workspaces docs
bpmct Apr 25, 2022
325c46c
remove coming soon
bpmct Apr 25, 2022
e37e4a4
fix typos
bpmct Apr 25, 2022
c010530
Merge branch 'bpmct/docs' of https://github.com/coder/coder into bpmc…
Apr 25, 2022
3bf7d4f
fix typos
bpmct Apr 25, 2022
ebcb866
Update docs/about.md
bpmct Apr 26, 2022
9c18282
remove line breaks between bullets
bpmct Apr 26, 2022
3e4318a
rename variables to parameters
bpmct Apr 26, 2022
8c93ae2
reduce limits
bpmct Apr 26, 2022
75af45b
merge
bpmct Apr 26, 2022
2ef477d
chore: edit text
Apr 26, 2022
c875319
Merge branch 'bpmct/docs' of https://github.com/coder/coder into bpmc…
Apr 26, 2022
81435b5
revert some changes, fix footnotes
bpmct Apr 26, 2022
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
Next Next commit
docs structure and edits to getting started
  • Loading branch information
@bpmct
bpmct committed Apr 22, 2022
commit eba2d489e8d8491e2a7fe2987ce06c05e7dab4eb
34 changes: 27 additions & 7 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ Provision remote development environments with Terraform.
- Start writing code with a single command
- Use one of many [examples](./examples) to get started

## Getting Started
## Installing Coder

Install [the latest release](https://github.com/coder/coder/releases).
Install [the latest release](https://github.com/coder/coder/releases) on a system with
at least 2 CPU cores and 2 GB RAM.

To tinker, start with dev-mode (all data is in-memory, and is destroyed on exit):

Expand All @@ -27,33 +28,35 @@ $ CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<pas
coder start
```

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

```bash
# Edit the configuration!
$ sudo vim /etc/coder.d/coder.env
$ sudo service coder restart
```

Reference `coder start --help` for a complete list of flags and environment variables.

### Your First Workspace

In a new terminal, create a new project (eg. Develop in Linux on Google Cloud):
In a new terminal, create a new template (eg. Develop in Linux on Google Cloud):

```
$ coder templates init
$ coder templates create
```

Create a new workspace and SSH in:
Create a new workspace and connect via SSH:

```
$ coder workspaces create my-first-workspace
$ coder ssh my-first-workspace
```

### Working with Projects
### Modifying Templates

You can edit the Terraform from a sample project:
You can edit the Terraform from a sample template:

```sh
$ coder templates init
Expand All @@ -62,6 +65,23 @@ $ vim main.tf
$ coder templates update gcp-linux
```

## Documentation

Some pages are coming soon. Contributions welcome!

- [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)
- Concepts
- Templates
- Workspaces
- Users and Organizations
- Guides
- Using the Coder CLI
- Install Coder on a VM with Caddy + LetsEncrypt
- Building templates in Coder

## Contributing

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