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

Tweak formatting of options tables #4730

Merged
merged 1 commit into from
Sep 30, 2017
Merged

Tweak formatting of options tables #4730

merged 1 commit into from
Sep 30, 2017

Conversation

mdlinville
Copy link

Move the deprecated or experimental info from its own column (which is usually redundant) to the flag description. Make the word bold as well.

cc/ @tiborvass who also asked for this.

@mdlinville mdlinville added area/ux Issue affects functionality of docs.docker.com area/engine Issue affects Docker engine/daemon labels Sep 27, 2017
@mdlinville
Copy link
Author

I just pushed an iteration I'm happy with! When the Netlify build finishes, have a look at the CLI refs for docker checkpoint create, docker container start, and docker search to see it in action.

@mdlinville
Copy link
Author

Don't merge, one more tweak coming.

@mdlinville
Copy link
Author

This looks great now! See https://deploy-preview-4730--docker-docs.netlify.com/engine/reference/commandline/build/

This shows how it looks like when you have multiple flags for specific flags.

So in summary, you now have API flags, deprecation, and experimental badges at the level of the command and the level of the options. This is great!

cc/ @londoncalling for how great this looks!

@tiborvass
Copy link
Contributor

This is awesome, thank you @mstanleyjones !

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.

❤️ awesome work! let me know when you're ready, but LGTM already

Copy link

@johndmulhausen johndmulhausen left a comment

Choose a reason for hiding this comment

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

A great improvement that our users will love. Thank you so much, @mstanleyjones ! Kicked off another Netlify build just in case.

@thaJeztah
Copy link
Member

FWIW; other enhancements we discussed;

  • show a New! badge for options/commands that were added in the current release; this could be done by comparing the current API version of the release with the API-version that's set on the command/flag
  • have a matrix/translation from API version to Docker version (as is included in the swagger.yml, so that we show Docker version instead of API version (which is more useful for users using the CLI)

@mdlinville mdlinville merged commit 7c800e7 into docker:master Sep 30, 2017
@mdlinville mdlinville deleted the cli-ref-followup branch September 30, 2017 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/engine Issue affects Docker engine/daemon area/ux Issue affects functionality of docs.docker.com
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants