Skip to content

feat: initial docs pages - #1107

Merged
bpmct merged 34 commits into
mainfrom
bpmct/docs
Apr 26, 2022
Merged

bpmct merged 34 commits into
mainfrom
bpmct/docs

Conversation

@bpmct

@bpmct bpmct commented Apr 22, 2022 •

Copy link
Copy Markdown
Member

Ready for review.

Closes #657 (see issue for discussion about docs MVP scope)

@bpmct
bpmct requested review from jsjoeio and kylecarbs April 22, 2022 20:35
Comment thread docs/about.md
# About Coder

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

Copy link
Copy Markdown
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

Comment thread docs/about.md
@@ -0,0 +1,48 @@
# About Coder

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@codecov

codecov Bot commented Apr 22, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #1107 (81435b5) into main (185d97a) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            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     
Flag Coverage Δ
unittest-go-macos-latest 53.56% <ø> (-0.07%) ⬇️
unittest-go-postgres- 65.57% <ø> (-0.23%) ⬇️
unittest-go-ubuntu-latest 56.09% <ø> (-0.24%) ⬇️
unittest-go-windows-2022 53.15% <ø> (?)
unittest-js 67.45% <ø> (+0.16%) ⬆️
Impacted Files Coverage Δ
coderd/workspaceagents.go 55.59% <0.00%> (-7.01%) ⬇️
coderd/httpapi/httpapi.go 66.25% <0.00%> (-6.25%) ⬇️
cli/workspaces.go 47.22% <0.00%> (-5.91%) ⬇️
cli/workspaceautostop.go 75.58% <0.00%> (-5.19%) ⬇️
cli/workspaceautostart.go 75.58% <0.00%> (-5.19%) ⬇️
coderd/organizations.go 56.70% <0.00%> (-3.95%) ⬇️
cli/workspacedelete.go 22.22% <0.00%> (-3.87%) ⬇️
codersdk/organizations.go 68.88% <0.00%> (-3.53%) ⬇️
cli/workspaceshow.go 16.66% <0.00%> (-3.34%) ⬇️
provisioner/echo/serve.go 56.80% <0.00%> (-2.41%) ⬇️
... and 35 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 185d97a...81435b5. Read the comment docs.

@bpmct
bpmct requested a review from khorne3 April 22, 2022 20:42
@bpmct bpmct mentioned this pull request Apr 22, 2022
@bpmct
bpmct marked this pull request as ready for review April 25, 2022 17:29

@kylecarbs kylecarbs left a comment

Copy link
Copy Markdown
Member

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 🔥🔥🔥

Comment thread docs/README.md Resolved
Comment thread docs/README.md Resolved
Comment thread docs/about.md Resolved
Comment thread docs/templates.md Resolved
Comment thread docs/templates.md Resolved
Comment thread docs/templates.md Resolved
@misskniss misskniss added this to the V2 Beta milestone Apr 25, 2022

@jsjoeio jsjoeio left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great work Ben 👏🏼

Comment thread docs/about.md

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Love this sentence 👏🏼

Comment thread docs/about.md Resolved
Comment thread docs/about.md Resolved
@bpmct
bpmct merged commit 22668c3 into main Apr 26, 2022
@bpmct
bpmct deleted the bpmct/docs branch April 26, 2022 17:10
@misskniss misskniss added switch blocker docs Area: coder.com/docs labels May 4, 2022
@misskniss misskniss mentioned this pull request May 9, 2022
45 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Area: coder.com/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

V2 Docs

6 participants