Changed docs to differentiate between docker compose standalone and plugin #22394
Conversation
… compose plugin and standalone version
|
Julian Rommel seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
There was a problem hiding this comment.
Hey @JulianRommel ! Thank you for your first Contribution! Welcome 🎉
I reviewed your PR and I have got two questions for you:
- Regarding your proposal: Is there really a need for instructions on docker engine (standalone)?
I would say no, since this adds complexity to the quick start and may cause some confusion (docker compose vs. -) Furthermore, user of the standalone version will be aware of using the (deprecated) hyphen command.
-
I found a typo on line 54: there is a backslash \ following the WSL_ which causes it to display in the documentation. It would be great if you can include this in you PR.
-
Please make sure to sign the CLA, so your PR can be further processed.
Thoughts?
|
Hey @juweins and thank you so much for your feedback! You are probably right about the standalone version. I will change it and also include a fix for the typo on line 54. |
Removed the docker compose standalone instructions, changed "tested on Ubuntu" version number and fixed typo
There was a problem hiding this comment.
Thanks for removing the odd character in line 54.
From my side, this LGTM! The changes are reasonable and provide value. @sh4sh
BTW:
My previous comment should initiate a little discussion and not terminate your proposals. You can bring in your thoughts, too! 👍🏽
Make sure to sign the CLA from your previous commit. I don't know what happened here.
|
@juweins that's weird, I have signed the CLA but it seems to be buggy. Any ideas how to fix this? I already removed it and signed it again... |
…lugin (airbytehq#22394) * Changed local deployment instructions to differentiate between docker compose plugin and standalone version * Removed docker compose standalone version Removed the docker compose standalone instructions, changed "tested on Ubuntu" version number and fixed typo --------- Co-authored-by: Julian Rommel <julian@Julians-Mac-mini.local>
What & How
I changed the local deployment instructions to better differentiate between docker-compose (standalone version) and docker compose (plugin). The docs aren't concise on this currently. I also changed the link to the Docker Engine installation guide, as this includes the Docker Compose plugin. Changed "tested on Ubuntu 20.04" to "... Ubuntu 22.04" and fixed typo on line 54(thanks @juweins).
🚨 User Impact 🚨
Should help users who haven't used docker before to find the correct version.