-
Notifications
You must be signed in to change notification settings - Fork 2k
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 markdown link in service-create reference docs #603
Conversation
Markdown nested in a HTML table doesn't work, so changing the link to a plain HTML link. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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 🐯
@@ -294,8 +294,9 @@ volumes in a service: | |||
<td> | |||
<p>The type of mount, can be either <tt>volume</tt>, <tt>bind</tt>, or <tt>tmpfs</tt>. Defaults to <tt>volume</tt> if no type is specified. | |||
<ul> | |||
<li><tt>volume</tt>: mounts a [managed volume](volume_create.md) into the container.</li> | |||
<li><tt>bind</tt>: bind-mounts a directory or file from the host into the container.</li> | |||
<li><tt>volume</tt>: mounts a <a href="https://docs.docker.com/engine/reference/commandline/volume_create/">managed volume</a> |
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.
This is an OK fix. Alternatively, you could add markdown="span"
as an attribute to the <li>
and leave the Markdown in there. Your choice. I think you could also avoid the <tt>
tags too, in favor of backticks.
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.
Oh, didn't know about that one! I think I'll keep it like this for now (mixing HTML and Markdown in a table may be confusing), but we could change it in a single go if we think it's better
Markdown nested in a HTML table doesn't work, so changing the link to a plain HTML link.
fixes #602
ping @johndmulhausen @mstanleyjones