-
Notifications
You must be signed in to change notification settings - Fork 889
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
feat: initial docs pages #1107
Conversation
# About Coder | ||
|
||
Coder is an open source platform for creating and managing developer workspaces on your preferred clouds and servers. | ||
|
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
@@ -0,0 +1,48 @@ | |||
# About Coder |
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.
This page was heavily inspired by https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/
Codecov Report
@@ Coverage Diff @@
## main #1107 +/- ##
==========================================
- Coverage 66.34% 66.27% -0.08%
==========================================
Files 257 263 +6
Lines 16055 16662 +607
Branches 156 156
==========================================
+ Hits 10652 11042 +390
- Misses 4311 4474 +163
- Partials 1092 1146 +54
Continue to review full report at Codecov.
|
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.
Top-tier docs. A few minor nits, but overall 🔥🔥🔥
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.
Great work Ben 👏🏼
|
||
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 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 comment
The reason will be displayed to describe this comment to others. Learn more.
Love this sentence 👏🏼
Co-authored-by: Joe Previte <jjprevite@gmail.com>
* docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * fix typos * Update docs/about.md Co-authored-by: Joe Previte <jjprevite@gmail.com> * remove line breaks between bullets * rename variables to parameters * reduce limits * chore: edit text * revert some changes, fix footnotes Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Joe Previte <jjprevite@gmail.com>
Ready for review.
Closes #657 (see issue for discussion about docs MVP scope)