Skip to content

feat: add comparison to docs #1315

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

Jump to bottom
Merged
merged 8 commits into from
May 10, 2022
Merged

feat: add comparison to docs #1315

merged 8 commits into from
May 10, 2022

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented May 5, 2022

This PR adds a comparison for Coder vs similar projects

Fixes #1304

@bpmct bpmct requested review from kylecarbs and khorne3 May 5, 2022 23:02
@bpmct bpmct self-assigned this May 5, 2022
@codecov
Copy link

codecov bot commented May 5, 2022 •
edited
Loading

Codecov Report

Merging #1315 (b69f600) into main (47f1fd5) will increase coverage by 0.10%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1315      +/-   ##
==========================================
+ Coverage   66.75%   66.85%   +0.10%     
==========================================
  Files         286      282       -4     
  Lines       18693    18493     -200     
  Branches      235      235              
==========================================
- Hits        12478    12364     -114     
+ Misses       4931     4865      -66     
+ Partials     1284     1264      -20
Flag Coverage Δ
unittest-go-macos-latest 54.08% <ø> (+0.04%) ⬆️
unittest-go-postgres- 65.48% <ø> (+0.04%) ⬆️
unittest-go-ubuntu-latest 56.44% <ø> (+0.01%) ⬆️
unittest-go-windows-2022 ?
unittest-js 73.67% <ø> (ø)
Impacted Files Coverage Δ
cli/configssh.go 62.58% <0.00%> (-6.48%) ⬇️
pty/ptytest/ptytest.go 86.95% <0.00%> (-4.35%) ⬇️
cli/templateinit.go 58.62% <0.00%> (-3.45%) ⬇️
agent/agent.go 64.66% <0.00%> (-1.24%) ⬇️
coderd/workspaceagents.go 55.34% <0.00%> (-0.70%) ⬇️
provisioner/terraform/provision.go 71.89% <0.00%> (-0.41%) ⬇️
provisioner/echo/serve.go 56.80% <0.00%> (ø)
pty/start_windows.go
agent/usershell/usershell_windows.go
pty/pty_windows.go
... and 9 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 47f1fd5...b69f600. Read the comment docs.

@bpmct bpmct changed the title feat: add comparison feat: add comparison to docs May 6, 2022
khorne3
khorne3 approved these changes May 6, 2022
View reviewed changes
Copy link
Contributor

@khorne3 khorne3 left a comment

Choose a reason for hiding this comment

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

minor edits

bpmct and others added 3 commits May 6, 2022 11:59
@bpmct @khorne3
Update docs/about.md
b4712e2 
Co-authored-by: Katie Horne <katie@23spoons.com>
@bpmct @khorne3
Update docs/about.md
a169eac 
Co-authored-by: Katie Horne <katie@23spoons.com>
@bpmct @khorne3
Update docs/about.md
963acc4 
Co-authored-by: Katie Horne <katie@23spoons.com>
@bpmct bpmct requested a review from ammario May 6, 2022 16:59
@bpmct bpmct enabled auto-merge (squash) May 10, 2022 16:20
@bpmct bpmct merged commit e8e4cf9 into main May 10, 2022
@bpmct bpmct deleted the bpmct/comparison branch May 10, 2022 16:32
ammario
ammario reviewed May 10, 2022
View reviewed changes
Copy link
Member

@ammario ammario left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Ugh.. I forgot to submit my review @bpmct. No worries, I'll submit commits later.

docs/about.md Outdated


| Tool | Type | Self-hosted version | Hosted version | Availability | Supported platforms |
| :------------------------------------------------------------------ | :---------------------------------- | :--------------------------- | :------------- | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
Copy link
Member

Choose a reason for hiding this comment

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

This is important enough to be in the README–just the table though–the preceding text is too much for the README.

Anmol did this with nhooyr/websocket and coder/slog, which greatly helped their successes.

docs/about.md Outdated
Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./about.md#what-coder-is-not).


| Tool | Type | Self-hosted version | Hosted version | Availability | Supported platforms |
Copy link
Member

Choose a reason for hiding this comment

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

I think type can be removed and we remove the Web IDEs

docs/about.md Outdated
| :------------------------------------------------------------------ | :---------------------------------- | :--------------------------- | :------------- | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Coder](https://github.com/coder/coder) | Platform: multiple workspaces and teams | ✅ | | Open source (paid version soon) | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 |
| [Coder (Classic)](https://coder.com/docs) | Platform: multiple workspaces and teams | ✅ | | Proprietary/paid license | Any Kubernetes cluster: Linux Containers |
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform: solo or team | Only GitHub Enterprise Cloud | ✅ | Open source/paid | Linux containers |
Copy link
Member

Choose a reason for hiding this comment

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

GitHub Enterprise Cloud is not self-hosted.
GitHub Codespaces is not open source either, we should just label it as "Free/Paid SaaS".

@ammario ammario mentioned this pull request May 10, 2022
Closed
@misskniss misskniss added this to the V2 Beta milestone May 15, 2022
kylecarbs pushed a commit that referenced this pull request Jun 10, 2022
@bpmct @khorne3 @kylecarbs
feat: add comparison to docs (#1315)
b07743d 
* fix typo

* feat: add comparison table

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* chore: remove gitpod

Co-authored-by: Katie Horne <katie@23spoons.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ammario ammario ammario left review comments

@khorne3 khorne3 khorne3 approved these changes

@kylecarbs kylecarbs Awaiting requested review from kylecarbs

Assignees

@bpmct bpmct

Labels
None yet
Projects
None yet
Milestone
V2 Beta
Development

Successfully merging this pull request may close these issues.

README has Comparison section for switch to public
4 participants
@bpmct @ammario @khorne3 @misskniss