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

Clarifying docker config rules #2077

Merged
merged 1 commit into from
Sep 16, 2019

Conversation

adrian-plata
Copy link
Contributor

@adrian-plata adrian-plata commented Sep 3, 2019

@adrian-plata
Copy link
Contributor Author

@andrewhsu and @thaJeztah PTAL. This is an attempt to clarify where the .docker/config.json file location is.

@codecov-io
Copy link

Codecov Report

Merging #2077 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2077   +/-   ##
=======================================
  Coverage   56.79%   56.79%           
=======================================
  Files         311      311           
  Lines       21836    21836           
=======================================
  Hits        12402    12402           
  Misses       8519     8519           
  Partials      915      915

@codecov-io
Copy link

codecov-io commented Sep 3, 2019

Codecov Report

Merging #2077 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2077      +/-   ##
==========================================
+ Coverage   56.78%   56.79%   +<.01%     
==========================================
  Files         311      311              
  Lines       21839    21836       -3     
==========================================
  Hits        12402    12402              
+ Misses       8522     8519       -3     
  Partials      915      915

@adrian-plata
Copy link
Contributor Author

Added information on enabling experimental features.

@andrewhsu andrewhsu self-requested a review September 9, 2019 18:08
Copy link
Contributor

@andrewhsu andrewhsu left a comment

Choose a reason for hiding this comment

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

I left some comments. I think a future PR could break up the https://docs.docker.com/engine/reference/commandline/cli/#configuration-files section into sub headings with experimental being one of them.

docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

Thanks! left some comments

docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved

Instructs Docker to use the configuration files in your `~/testconfigs/`
directory when running the `ps` command.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps in this location, we should explain that the --config flag is only applying to the command that's run (i.e., it's not updating the default configuration, and only applies to the command that you ran with that flag set).

After explaining that, I think we should add a second example that's using the DOCKER_CONFIG environment variable; we can show that example using export DOCKER_CONFIG=........, and below the example add a note that if they want to persist that configuration, they can set it in, e.g. their ~/.profile (or ~/.bashrc, or whatever flavour of shell they're using)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you expand on the second example more?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took a shot at the command, how does it look @thaJeztah ?

docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
docs/reference/commandline/cli.md Outdated Show resolved Hide resolved
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

left two comments, otherwise LGTM

directory to be `HOME/newdir/.docker`.

```bash
export DOCKER_CONFIG=$HOME/newdir/.docker > ~/.profile
Copy link
Member

Choose a reason for hiding this comment

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

I think this is missing an echo

Suggested change
export DOCKER_CONFIG=$HOME/newdir/.docker > ~/.profile
echo export DOCKER_CONFIG=$HOME/newdir/.docker > ~/.profile

```

You can also enable experimental features from the Docker Desktop menu. See the
[Docker Desktop Getting Started page](https://github.com/docker/docker.github.io/blob/master/docker-for-mac/index.md#experimental-features)
Copy link
Member

Choose a reason for hiding this comment

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

We should probably link to the docs.docker.com site instead (otherwise, once this is published on docs.docker.com, we direct people to GitHub instead of staying on docs.docker.com);

Suggested change
[Docker Desktop Getting Started page](https://github.com/docker/docker.github.io/blob/master/docker-for-mac/index.md#experimental-features)
[Docker Desktop Getting Started page](https://docs.docker.com/docker-for-mac/#experimental-features)

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants