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

Remote API doc formatting comments #5278

Closed
vieux opened this issue Apr 17, 2014 · 6 comments · Fixed by #8343
Closed

Remote API doc formatting comments #5278

vieux opened this issue Apr 17, 2014 · 6 comments · Fixed by #8343

Comments

@vieux
Copy link
Contributor

vieux commented Apr 17, 2014

I think for the Remote APID docs (http://docs.docker.io/reference/api/docker_remote_api_v1.10/)

All the blocks **Example request** should be in the much smaller font.
And in a monospace font, it's supposed to be code.

See http://cl.ly/image/3M3s1y0V2o1Y/Screen%20Shot%202014-04-17%20at%2015.28.52.png

@vieux
Copy link
Contributor Author

vieux commented Apr 17, 2014

ping @SvenDowideit @jamtur01 @ostezer

@vieux
Copy link
Contributor Author

vieux commented Apr 17, 2014

Related to #5277

@ghost ghost self-assigned this Apr 17, 2014
@ghost
Copy link

ghost commented Jun 16, 2014

@SvenDowideit @jamtur01 any thoughts on this one?

@jamtur01
Copy link
Contributor

@ostezer I am going to err on the side of you being a better design eye than me. But yes I see the issue.

@ghost
Copy link

ghost commented Jun 16, 2014

@jamtur01 don't think it's really a styling issue ;-)
In fact, I'm pretty certain this was fixed before.

We will need to take out all text like:

  • **Example request**
  • **Example response**

out of code-blocks AND make sure that they don't get overridden during API docs updates.

Any thoughts on a possible plan of action?
(other than the obvious PR to fix the page now, to make sure they stay fixed)

@vieux vieux unassigned ghost Jul 24, 2014
@duglin
Copy link
Contributor

duglin commented Sep 30, 2014

See what you guys think of my change in duglin@01f290e
I makes the lines @vieux was talking about smaller - and I think more readable - I agree they were kind of large.
I can submit this as a PR if you guys are ok with it.

duglin pushed a commit to duglin/docker that referenced this issue Oct 6, 2014
Closes moby#5278

Signed-off-by: Doug Davis <dug@us.ibm.com>
fredlf pushed a commit that referenced this issue Oct 6, 2014
Make fixed font sizes smaller per Issue #5278
nathanleclaire pushed a commit to nathanleclaire/docker that referenced this issue Oct 12, 2014
Closes moby#5278

Signed-off-by: Doug Davis <dug@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants