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.

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
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
Prev Previous commit
Next Next commit
fix typos
  • Loading branch information
bpmct committed Apr 25, 2022
commit a803f8a09e389bc2c95feef265071aa0b98f2cc9
10 changes: 5 additions & 5 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

Coder is an open source platform for creating and managing developer workspaces on your preferred clouds and servers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there should be a screenshot to break up the text-heavy stuff

By building on top of common development inferfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this sentence 👏🏼


> ⚠️ Coder v2 is in alpha and not ready for production use. You may be interested in [Coder v1](https://coder.com/docs) or [code-server](https://github.com/cdr/code-server).

## Why remote development

Migrating from local developer machines to remote servers is an increasingly common solution for developers[^1] and organizations[^2] alike. Remote development has a number of benefits:

- Speed: Server-grade compute speeds up operations in software development such as IDE loads, compiles, builds, and running large apps (monolyths or many microservices).
- Speed: Server-grade compute speeds up operations in software development such as IDE loads, compiles, builds, and running large workloads (monolyth or microservice applications).

- Environment management: Onboarding & troubleshooting development environments is automated using tools such as Terraform, nix, Docker, devcontainers, etc.

- Security: Source code and other data can be centralized on private servers or cloud, instead of local developer machines.

- Compatability: Remote workspaces share infrastructure configuration with other developer, staging, and production environments, reducing configuration drift.
- Compatibility: Remote workspaces share infrastructure configuration with other developer, staging, and production environments, reducing configuration drift.

- Accessibility: Devices such as light notebooks, Chromebooks, and iPads connect to remote workspaces via browser-based IDEs or remote IDE extensions.

Expand All @@ -27,9 +27,9 @@ The added layer of infrastructure control is a key differentiator from Coder v1
- support ARM, Windows, Linux, and MacOS workspaces
- modify pod/container spec: add disks, manage network policy, environment variables
- use VM/dedicated workspaces: develop with Kernel features, container knowledge not required
- enable persistant workspaces: just like a local machine, but faster and in the cloud
- enable persistent workspaces: just like a local machine, but faster and in the cloud

Coder includes [production-ready templates](./examples) for use on Kubernetes, AWS EC2, Google Cloud, Azure, and more.
Coder includes [production-ready templates](../examples) for use on Kubernetes, AWS EC2, Google Cloud, Azure, and more.

## What Coder is not

Expand Down