Merge pull request #10461 from thaJeztah/update_reference_layout

Update layout of reference pages
This commit is contained in:
Usha Mandya 2020-03-16 15:24:06 +00:00 committed by GitHub
commit aed15be190
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 40 deletions

View File

@ -89,6 +89,18 @@ your client and daemon API versions.
```
{% endif %}
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
## Extended description
{{ site.data[include.datafolder][include.datafile].long }}
{% endunless %}
{% if site.data[include.datafolder][include.datafile].examples %}
For example uses of this command, refer to the [examples section](#examples) below.
{% endif %}
{% if site.data[include.datafolder][include.datafile].options %}
{% if site.data[include.datafolder][include.datafile].inherited_options %}
{% assign alloptions = site.data[include.datafolder][include.datafile].options | concat:site.data[include.datafolder][include.datafile].inherited_options %}
@ -130,27 +142,17 @@ your client and daemon API versions.
{% endif %} <!-- end if options -->
{% if site.data[include.datafolder][include.datafile].cname %}
{% if site.data[include.datafolder][include.datafile].examples %}
## Child commands
## Examples
{{ site.data[include.datafolder][include.datafile].examples }}
{% endif %}
{% else %}
The include.datafolder or include.datafile was not set.
<table>
<thead>
<tr>
<td>Command</td>
<td>Description</td>
</tr>
</thead>
<tbody>
{% for command in site.data[include.datafolder][include.datafile].cname %}
{% capture dataFileName %}{{ command | strip | replace: " ","_" }}{% endcapture %}
<tr>
<td markdown="span">[{{ command }}]({{ dataFileName | replace: "docker_","" }}/)</td>
<td markdown="span">{{ site.data[include.datafolder][dataFileName].short }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if site.data[include.datafolder][include.datafile].pname %}
@ -174,6 +176,29 @@ your client and daemon API versions.
{% endunless %}
{% endif %}
{% if site.data[include.datafolder][include.datafile].cname %}
## Child commands
<table>
<thead>
<tr>
<td>Command</td>
<td>Description</td>
</tr>
</thead>
<tbody>
{% for command in site.data[include.datafolder][include.datafile].cname %}
{% capture dataFileName %}{{ command | strip | replace: " ","_" }}{% endcapture %}
<tr>
<td markdown="span">[{{ command }}]({{ dataFileName | replace: "docker_","" }}/)</td>
<td markdown="span">{{ site.data[include.datafolder][dataFileName].short }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% unless site.data[include.datafolder][include.datafile].pname == "docker" or site.data[include.datafolder][include.datafile].pname == "dockerd" or include.datafile=="docker" %}
## Related commands
@ -197,24 +222,3 @@ your client and daemon API versions.
</table>
{% endunless %}
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
## Extended description
{{ site.data[include.datafolder][include.datafile].long }}
{% endunless %}
{% if site.data[include.datafolder][include.datafile].examples %}
## Examples
{{ site.data[include.datafolder][include.datafile].examples }}
{% endif %}
{% else %}
The include.datafolder or include.datafile was not set.
{% endif %}