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

Fix incorrect command in Docker configuration for Colima #42078

Closed
wants to merge 1 commit into from

Conversation

martinfrancois
Copy link
Contributor

@martinfrancois martinfrancois commented Sep 1, 2024

As the dot is currently included in the backticks in the docs, this suggests that it should be included in the commend that should be executed as well. However, this would be incorrect, as it would result in a path that would end with a dot as well.

I put the dot after the backticks to make it clear it doesn't belong to the command. As the dot was always present in other similar instances in the docs I kept it, but if it wasn't for consistency I would be inclined to remove it entirely to make it even more foolproof.

@pivotal-cla
Copy link

@martinfrancois Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@pivotal-cla
Copy link

@martinfrancois Thank you for signing the Contributor License Agreement!

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Sep 1, 2024
@philwebb
Copy link
Member

philwebb commented Sep 1, 2024

Thanks @martinfrancois, for even more clarity we could do something like this:

The plugin can communicate with the Docker daemon provided by https://github.com/abiosoft/colima[Colima].
The `DOCKER_HOST` environment variable can be set by using the following command:

[source,shell,subs="verbatim,attributes"]
----
$ export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}')
----

What do you think? Are you interested in updating your PR?

@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Sep 1, 2024
@philwebb philwebb added this to the 3.3.x milestone Sep 1, 2024
@martinfrancois
Copy link
Contributor Author

You're welcome, and thanks as well @philwebb, I really like the idea, makes it even clearer without introducing inconsistencies. I changed it as you suggested.

@philwebb
Copy link
Member

philwebb commented Sep 2, 2024

Thanks again @martinfrancois, this has now been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants