-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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: Update contributors-quickstart.md to include Docker instructions for Mac. #16861
base: master
Are you sure you want to change the base?
Conversation
…Mac. Signed-off-by: Laraib21 <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #16861 +/- ##
=======================================
Coverage 49.30% 49.30%
=======================================
Files 272 272
Lines 47985 47985
=======================================
Hits 23660 23660
Misses 21983 21983
Partials 2342 2342 ☔ View full report in Codecov by Sentry. |
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.
LGTM, thanks!
@@ -25,6 +25,9 @@ git clone https://github.com/argoproj/argo-cd.git | |||
|
|||
<https://docs.docker.com/engine/install/> | |||
|
|||
#### Note for Mac users: |
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.
Are these instructions specific for Mac only? I'd imagine that this would need to be done for Linux as well?
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.
@blakepettersson I believe it's Docker Desktop specific. So title should be changed to
#### Note for Docker Desktop users:
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.
These are really instructions for Docker Desktop, it should just be part of those instructions.
@Laraib21 Looking at this PR again, it needs to be changed. There are two different instruction steps, one is to install docker, which is needed, and the 2nd is to setup some kind of local cluster. Instead of telling mac users to enable kubernetes on Docker desktop, lets make Docker desktop one of the setup options below where the kind cluster setup is listed. That would make more sense. |
Hi, before I make the commit with the changed instructions I wanted to post them here, first: """ Step 1: Install Docker Desktop Option A: Using Docker Desktop Ensure Docker is running on your machine. |
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.
I would change the title to be
#### Note for Docker Desktop users:
Signed-off-by: Laraib Iqbal [email protected]
This change adds instructions for those who are trying to get set-up with ArgoCD on Mac and are using Docker Desktop. I was having trouble using Docker Desktop myself and so I deemed it important to add, so other Mac users don't waste time on the same issue.
Checklist: