docs: update info for local development #204
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #204 +/- ##
=======================================
Coverage 88.94% 88.94%
=======================================
Files 111 111
Lines 2740 2740
=======================================
Hits 2437 2437
Misses 253 253
Partials 50 50 |
I think completing go-vela/community#4 and/or adding some explanation of the services being utilized would be very helpful for newcomers. Some brief network/flow diagram would also likely help illustrate how everything works. |
|
@JordanSussman I believe I have addressed your feedback 👍 Please let me know your thoughts when you have a chance! |
wass3r
previously approved these changes
Oct 26, 2020
JordanSussman
previously approved these changes
Oct 27, 2020
wass3r
approved these changes
Oct 28, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to #202
It's been a long time since the local development docs have been updated so thought I'd give it a try.
For convenience, here are links to the old/new local development docs:
Found within this PR are the following changes:
DOCS.mdto the root of the repository so it's easier to find (previously was nested under.github)DOCS.mdcontent to be more focused on starting the Vela stack usingmakeDOCS.mdwith information on the different compose servicesDOCS.mdinstructions for running builds locally when the Vela stack is startedCONTRIBUTING.mdto reference theDOCS.mdto reduce duplication of docsdocker-compose.ymlto use'for strings (previously, we were using'and"interchangeably)secrets.env.examplefile so users can reference it as a guide to creating their ownWhile doing this, I was battling with myself on trying to keep the docs "lightweight" while providing valuable content.
It left me with questions that I'll provide here:
makecommands are doing in depth?I think once we get some of this stuff figured out, I'll plan to make the same/similar changes to go-vela/ui and go-vela/worker.