-
Notifications
You must be signed in to change notification settings - Fork 41
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: add quickstart documentation #193
Conversation
quickstart/README.md
Outdated
@@ -0,0 +1,63 @@ | |||
# Dagger Quickstart |
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.
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.
Moved.
Have also linked the quickstart in the main README
https://github.com/odpf/dagger/pull/193/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
quickstart/README.md
Outdated
|
||
## Quickstart | ||
|
||
1. Clone dagger repository into you local. Checkout into the branch [`doc/add-quickstart-documentation`](https://github.com/odpf/dagger/tree/doc/add-quickstart-documentation). (You should see a folder at the top level called `quickstart` containing this README.) |
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.
we can change the path now
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.
Done
- edit the local.properties for running locally
- add link to quickstart in readme
6b4b86c
to
afd814d
Compare
This is the first step towards creating a better quickstart documentation. Contains more step by step details on how to run dagger locally.
In the future, we will add more examples.