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: add quickstart documentation #193

Merged
merged 6 commits into from
Sep 27, 2022

Conversation

Meghajit
Copy link
Member

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.

@Meghajit Meghajit self-assigned this Sep 20, 2022
@Meghajit Meghajit added the documentation Improvements or additions to documentation label Sep 20, 2022
@@ -0,0 +1,63 @@
# Dagger Quickstart
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

@Meghajit Meghajit Sep 26, 2022

Choose a reason for hiding this comment

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


## 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.)
Copy link
Member

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@Meghajit Meghajit force-pushed the doc/add-quickstart-documentation branch from 6b4b86c to afd814d Compare September 26, 2022 13:57
@prakharmathur82 prakharmathur82 changed the title doc: add quickstart documentation docs: add quickstart documentation Sep 27, 2022
@prakharmathur82 prakharmathur82 merged commit b93574c into main Sep 27, 2022
@prakharmathur82 prakharmathur82 deleted the doc/add-quickstart-documentation branch September 27, 2022 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

runFlink fails on fresh checkout repo
2 participants