-
Notifications
You must be signed in to change notification settings - Fork 894
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
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 1283422
draft for about page
bpmct 8cb6a88
skeleton for concepts page
bpmct 4c1b767
attempt at explaining templates
bpmct d5f5116
left-align tables
bpmct de9f3af
add best practices and variables
bpmct 892122c
update structrure
bpmct c526982
update structure
bpmct 68da32e
templates are shared
bpmct 808767e
workspaces docs
bpmct c8f1e25
remove coming soon
bpmct a803f8a
fix typos
bpmct 1bb34bd
docs structure and edits to getting started
bpmct 97f03e0
draft for about page
bpmct 0485c6c
skeleton for concepts page
bpmct 0e1bc57
attempt at explaining templates
bpmct 57d4d0f
left-align tables
bpmct fc48d53
add best practices and variables
bpmct 361decc
update structrure
bpmct 950ee85
update structure
bpmct afac7ee
templates are shared
bpmct e67dabb
workspaces docs
bpmct 325c46c
remove coming soon
bpmct e37e4a4
fix typos
bpmct c010530
Merge branch 'bpmct/docs' of https://github.com/coder/coder into bpmc…
3bf7d4f
fix typos
bpmct ebcb866
Update docs/about.md
bpmct 9c18282
remove line breaks between bullets
bpmct 3e4318a
rename variables to parameters
bpmct 8c93ae2
reduce limits
bpmct 75af45b
merge
bpmct 2ef477d
chore: edit text
c875319
Merge branch 'bpmct/docs' of https://github.com/coder/coder into bpmc…
81435b5
revert some changes, fix footnotes
bpmct File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix typos
- Loading branch information
commit e37e4a4c7b7706c5b498475ebf94ba1b7d10a90d
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,21 +2,21 @@ | |
|
||
Coder is an open source platform for creating and managing developer workspaces on your preferred clouds and servers. | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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). | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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. | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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. | ||
|
||
|
@@ -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 | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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