-
Notifications
You must be signed in to change notification settings - Fork 28
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: update info for local development #204
Conversation
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! |
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.
lgtm
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.md
to the root of the repository so it's easier to find (previously was nested under.github
)DOCS.md
content to be more focused on starting the Vela stack usingmake
DOCS.md
with information on the different compose servicesDOCS.md
instructions for running builds locally when the Vela stack is startedCONTRIBUTING.md
to reference theDOCS.md
to reduce duplication of docsdocker-compose.yml
to use'
for strings (previously, we were using'
and"
interchangeably)secrets.env.example
file 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:
make
commands 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.