docs: add quickstart documentation #193
Merged
Conversation
This file contains hidden or 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
This was
linked to
issues
Sep 20, 2022
prakharmathur82
requested changes
Sep 26, 2022
| @@ -0,0 +1,63 @@ | |||
| # Dagger Quickstart | |||
Member
There was a problem hiding this comment.
can we move this at https://github.com/odpf/dagger/tree/doc/add-quickstart-documentation/docs/docs/guides?
Member
Author
There was a problem hiding this comment.
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.) |
Member
There was a problem hiding this comment.
we can change the path now
- edit the local.properties for running locally
- add link to quickstart in readme
6b4b86c to
afd814d
Compare
prakharmathur82
approved these changes
Sep 27, 2022
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.
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.