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

Show expected Docker compose output in README #4

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

rachhouse
Copy link
Contributor

@rachhouse rachhouse commented Dec 16, 2024

Addressing review feedback that arrived post-PR: include the expected terminal output of Docker compose in the README.

Check out the rendered README here: https://github.com/greatexpectationslabs/tutorial-gx-in-the-data-pipeline/tree/show-docker-compose-output?tab=readme-ov-file#quickstart

@rachhouse rachhouse self-assigned this Dec 16, 2024
@rachhouse rachhouse requested a review from r34ctor December 16, 2024 18:54
Copy link

@r34ctor r34ctor left a comment

Choose a reason for hiding this comment

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

The only change to consider making is to add instructions for what to do if a user does not see this output, but that is pretty minor.

@rachhouse
Copy link
Contributor Author

The only change to consider making is to add instructions for what to do if a user does not see this output, but that is pretty minor.

@r34ctor Thanks for the review! That's a good point. I'm need to give it a bit of thought, so I'm going to merge this PR for now while I think about how to address it. The key considerations are:

  1. I don't want to bog down the Quickstart with a lot of detail that ideally most users won't need.
  2. A link to a troubleshooting page or section that covers the issue could be a good alternative. However, if the Docker compose command doesn't run as expected on a user's machine, there's limited guidance we can give (other than "try it again") without knowing the user's specific error.

@rachhouse rachhouse merged commit 37d4840 into main Dec 16, 2024
2 checks passed
@rachhouse rachhouse deleted the show-docker-compose-output branch December 16, 2024 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants