Skip to content
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

docs: Clarify develop and add manual-run commands #455

Merged
merged 2 commits into from
Mar 16, 2022

Conversation

bryphe-coder
Copy link
Contributor

@bryphe-coder bryphe-coder commented Mar 16, 2022

This adds a couple of missing pieces to the docs:

  • More info about ./develop.sh
  • Steps to run the built coder binary manually
    • Starting the server
    • Logging in
    • Creating a project

I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when #422 is merged

@codecov
Copy link

codecov bot commented Mar 16, 2022

Codecov Report

Merging #455 (cf05e97) into main (548b4f2) will increase coverage by 3.68%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #455      +/-   ##
==========================================
+ Coverage   64.23%   67.91%   +3.68%     
==========================================
  Files          72      157      +85     
  Lines         794     9222    +8428     
  Branches       73       73              
==========================================
+ Hits          510     6263    +5753     
- Misses        270     2331    +2061     
- Partials       14      628     +614     
Flag Coverage Δ
unittest-go-ubuntu-latest 67.49% <ø> (?)
unittest-go-windows-2022 62.22% <ø> (?)
unittest-js 64.23% <ø> (ø)
Impacted Files Coverage Δ
httpmw/workspaceparam.go 76.47% <0.00%> (ø)
coderd/coderd.go 96.18% <0.00%> (ø)
database/db.go 55.17% <0.00%> (ø)
agent/usershell/usershell_windows.go 0.00% <0.00%> (ø)
peerbroker/proxy.go 57.55% <0.00%> (ø)
coderd/workspaces.go 51.29% <0.00%> (ø)
peerbroker/dial.go 75.43% <0.00%> (ø)
database/pubsub_memory.go 94.87% <0.00%> (ø)
peer/conn.go 78.00% <0.00%> (ø)
cli/workspaces.go 100.00% <0.00%> (ø)
... and 75 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 548b4f2...cf05e97. Read the comment docs.

Copy link
Contributor

@greyscaled greyscaled left a comment

Choose a reason for hiding this comment

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

Nice!

Copy link
Contributor

@presleyp presleyp left a comment

Choose a reason for hiding this comment

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

This is great, thanks!

@bryphe-coder bryphe-coder enabled auto-merge (squash) March 16, 2022 03:43
@bryphe-coder bryphe-coder merged commit 15beb98 into main Mar 16, 2022
@bryphe-coder bryphe-coder deleted the bryphe/docs/add-commands-to-docs branch March 16, 2022 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants