docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Site-specific changes for Edge

This commit is contained in:
Misty Stanley-Jones 2017-04-03 12:57:44 -07:00 committed by Misty Stanley-Jones
parent 3874bf2c60
commit e796ce8148
6 changed files with 223 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Dockerfile
View File

@ -14,6 +14,9 @@ COPY . md_source
# into static HTML in the "target" directory using Jekyll
# then nuke the md_source directory.
# Process this as an Edge release
ENV EDGE 1
## Branch to pull from, per ref doc
## To get master from svn the svn branch needs to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname'
ENV ENGINE_SVN_BRANCH="branches/17.04.x"
@ -43,7 +46,7 @@ RUN svn co https://github.com/docker/docker/$ENGINE_SVN_BRANCH/docs/extend md_so
&& wget -O md_source/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/v1.13.0/api/swagger.yaml \
&& wget -O md_source/engine/api/v1.26/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.03.0-ce/api/swagger.yaml \
&& wget -O md_source/engine/api/v1.27/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
&& jekyll build -s md_source -d target \
&& (if [ $EDGE -eq 1 ]; then jekyll build -s md_source -d target --config md_source/_config-edge.yml; else jekyll build -s md_source -d target; fi)\
&& rm -rf target/apidocs/layouts \
&& find target -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& rm -rf md_source

173
_config-edge.yml Normal file
View File

@ -0,0 +1,173 @@
name: Docker CE Edge Documentation
markdown: kramdown
kramdown:
input: GFM
html_to_native: true
hard_wrap: false
syntax_highlighter: rouge
toc_levels: 2..3
incremental: true
permalink: pretty
safe: false
lsi: false
url: https://docs.docker.com/edge/
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13"]
edge: true # set to true if the next expected release is going to the edge channel
gems:
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-relative-links
webrick:
headers:
Cache-Control: 600
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: docs
defaultassignee: johndmulhausen
enginebranch: 1.13.x
toc_min: 2
toc_max: 3
tree: true
- scope:
path: "compose"
values:
assignee: "londoncalling"
- scope:
path: "cs-engine"
values:
assignee: "joaofnfernandes"
- scope:
path: "datacenter"
values:
assignee: "joaofnfernandes"
- scope:
path: "docker-cloud"
values:
assignee: "londoncalling"
- scope:
path: "docker-for-mac"
values:
assignee: "londoncalling"
- scope:
path: "docker-for-windows"
values:
assignee: "londoncalling"
- scope:
path: "docker-hub"
values:
assignee: "johndmulhausen"
- scope:
path: "docker-store"
values:
assignee: "johndmulhausen"
- scope:
path: "engine"
values:
assignee: "mstanleyjones"
- scope:
path: "kitematic"
values:
assignee: "londoncalling"
- scope:
path: "machine"
values:
assignee: "londoncalling"
- scope:
path: "notary"
values:
assignee: "johndmulhausen"
- scope:
path: "registry"
values:
assignee: "joaofnfernandes"
- scope:
path: "swarm"
values:
assignee: "mstanleyjones"
- scope:
path: "toolbox"
values:
assignee: "londoncalling"
-
scope:
path: "datacenter"
values:
ucp_latest_image: "docker/ucp:2.1.2"
dtr_latest_image: "docker/dtr:2.2.3"
-
scope:
path: "datacenter/dtr/2.2"
values:
ucp_version: "2.1"
dtr_version: "2.2"
docker_image: "docker/dtr:2.2.3"
-
scope:
path: "datacenter/dtr/2.1"
values:
hide_from_sitemap: true
ucp_version: "2.0"
dtr_version: "2.1"
-
scope:
path: "datacenter/dtr/2.0"
values:
hide_from_sitemap: true
ucp_version: "1.1"
dtr_version: "2.0"
-
scope:
path: "datacenter/ucp/2.1"
values:
ucp_version: "2.1"
dtr_version: "2.2"
docker_image: "docker/ucp:2.1.2"
-
scope:
path: "datacenter/ucp/2.0"
values:
hide_from_sitemap: true
ucp_version: "2.0"
dtr_version: "2.1"
docker_image: "docker/ucp:2.0.3"
-
scope:
path: "datacenter/ucp/1.1"
values:
hide_from_sitemap: true
ucp_version: "1.1"
dtr_version: "2.0"
-
scope:
path: "apidocs/v1.3.3"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v1.4.0"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v2.0.0"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v2.0.1"
values:
hide_from_sitemap: true
# Assets
#
# We specify the directory for Jekyll so we can use @imports.
sass:
sass_dir: _scss
style: :compressed

4
_includes/global-header.html
View File

@ -40,7 +40,7 @@
<ul>
<li><a href="https://cloud.docker.com/">Create Docker ID</a></li>
<li><a href="https://cloud.docker.com/login">Sign In</a></li>
</ul>
</ul>
</div> -->
</div>
<!--/.nav-collapse -->
@ -53,7 +53,7 @@
<div class="row">
<div class="hero-text">
<div class="hero-text-centered">
<h1>Docker Documentation</h1>
<h1>{{ site.name }}</h1>
<p>Docker provides a way to run applications securely isolated in a container, packaged with all its dependencies and libraries.</p>
<ul class="buttons">
<li><a class="button transparent-btn" href="/engine/installation/" target="_blank">Get Docker</a></li>

7
_layouts/docs.html
View File

@ -82,9 +82,12 @@ else %}{% assign edit_url = "" %}{% endif %} {% break %} {% endif %} {% endfor %
<div class="col-body">
<main class="col-content {% if page.landing == true %}main-content{%else%}content{% endif %}">
<section class="section">
{% if page.title %}
{% if page.url == '/' %}
<h1>{{ site.name }}</h1>
{% else %}
{% if page.title %}
<h1>{{ page.title }}</h1>{% endif %} {% if page.advisory %}
<blockquote>{{ site.data.advisories.texts[page.advisory] | markdownify }}</blockquote>{% endif %} {% unless page.tree == false %}{% include read_time.html %}{% endunless %}{{ content }}
<blockquote>{{ site.data.advisories.texts[page.advisory] | markdownify }}</blockquote>{% endif %}{% endif %} {% unless page.tree == false %}{% include read_time.html %}{% endunless %}{{ content }}
<script language="JavaScript">
var x = document.links.length;
var baseHref = document.getElementsByTagName('base')[0].href

24
engine/installation/index.md
View File

@ -9,9 +9,9 @@ redirect_from:
title: Install Docker
---
## Docker variants
## Docker editions
Docker is available in multiple variants:
Docker is available in two editions:
- **Docker Enterprise Edition (Docker EE)** is designed for enterprise
development and IT teams who build, ship, and run business critical
@ -29,10 +29,12 @@ Docker is available in multiple variants:
share containers and automate the development pipeline all from a single
environment.
Docker CE gives you the option to run **stable** or **edge** builds.
Docker CE has both **stable** and **edge** channels.
- **Stable** builds are released once per quarter.
- **Edge** builds are released once per month.
- **Edge** builds are released once per month, except during the months that
Edge builds are released. If you subscribe to the Edge channel, you should
also subscribe to the Stable channel.
For more information about Docker CE, see
[Docker Community Edition](https://www.docker.com/community-edition/){: target="_blank" class="_" }.
@ -56,17 +58,9 @@ Digital Ocean, Packet, SoftLink, or Bring Your Own Cloud.
## Time-based release schedule
Starting with Docker 17.03, Docker uses semantic versioning and a time-based
release schedule, outlined below. There may be times when exceptions need to be
made, but this is the goal.
- Ideally, a Docker CE release is published the first week of each month.
- In March, June, September, and December, the release will be published to the
**stable** channel.
- The rest of the time, this monthly release will be published to the **edge**
channel.
- At the end of the month in March, June, September, and December, a Docker EE
release is published.
Starting with Docker 17.03, Docker uses a time-based release schedule, outlined
below. For Docker CE Edge users, if you want to receive each month's release,
you need to subscribe to both the Edge and Stable channels.
{% include docker_schedule_matrix.md %}

51
index.md
View File

@ -5,22 +5,32 @@ landing: true
title: Docker Documentation
notoc: true
---
{% assign page.title = site.name %}
Docker packages your app with its dependencies, freeing you from worrying about
your system configuration, and making your app more portable.
{% if site.edge == true %}
{% capture ce-edge-section %}
## Docker CE Edge
The Docker CE Edge channel provides monthly releases which allow you to try
new features of Docker and verify bug fixes quickly. Edge releases are only
supported for one month, including security updates and high priority bug fixes
only. When a new release becomes available in the Docker CE Edge channel,
previous releases stop receiving updates. Commercial support is not available
for Docker CE.
supported for one month, and a given Edge release will not receive any updates
after this period.
Stable releases are not published to the Edge channel, so you still need to
subscribe to the Stable channel as well. Commercial support is not available for
Docker CE.
For information about all Docker release channels and expectations about
support, see [Docker channels](/engine/installation/#docker-channels)
support, see [Docker channels](/engine/installation/#docker-channels).
<!-- This button toggles the div below, and hides itself when clicked -->
<a id="ce-edge-readmore-btn" onclick="$(this).hide(); ga('send', 'event', 'ce-edge-readmore', 'click', 'CE engagement');" data-target="#ce-edge-readmore" data-toggle="collapse" class="button outline-btn collapse in">Read more about Docker CE Edge releases</a>
<div markdown="1" id="ce-edge-readmore" class="collapse" data-target="#ce-edge-readmore-btn" data-toggle="collapse">
This page lists features that are only available in Docker CE Edge releases.
Where applicable, the API and CLI reference documentation has been updated to
@ -33,10 +43,9 @@ available until a Docker CE Stable release incorporates the feature**.
<li class="active"><a data-toggle="tab" data-target="#1704">17.04</a></li>
<!--<li><a data-toggle="tab" data-target="#1705">17.05</a></li>-->
</ul>
<div class="tab-content">
<div id="1704" class="tab-pane fade in active">
<div markdown="1" class="tab-content">
<div markdown="1" id="1704" class="tab-pane fade in active">
{% capture release-notes %}
#### Docker CE Edge 17.04
The following major features and changes are included in Docker CE Edge 17.04.
@ -44,6 +53,8 @@ Continue reading, or go straight to [API and CLI](#api-and-cli),
[Daemon](#daemon), [Dockerfile](#dockerfile), [Services](#services), or
[Stacks](#stacks).
[Read the full release notes](https://github.com/docker/docker/releases/tag/v17.04.0-ce){: target="_blank" class="_" }
##### API and CLI
- Add `--device-cgroup-rule` flag to give containers access to devices that appear
@ -184,35 +195,33 @@ Continue reading, or go straight to [API and CLI](#api-and-cli),
types of endpoints and expands the options you can use when specifying mounts.
{% include github-pr.md pr=31795 %}
{% endcapture %}
{{ release-notes | markdownify }}
</div>
</div> <!-- 17.04 -->
<!--<div id="1705" class="tab-pane fade">TAB 2 CONTENT</div>-->
</div>
</div> <!-- tab-content -->
</div> <!-- ce-edge-readmore -->
{% endcapture %} <!-- from line 13 -->
{{ ce-edge-section | markdownify }}
{% endif %}
<div class="row">
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-6 block">
{% capture basics %}
<div markdown="1" class="col-xs-12 col-sm-12 col-md-12 col-lg-6 block">
### Learn Docker basics
Get started learning Docker concepts, tools, and commands. The examples show you
how to build, push, and pull Docker images, and run them as containers. This
tutorial stops short of teaching you how to deploy applications.
{% endcapture %}{{ basics | markdownify }}
{% capture basics %}[Start the basic tutorial](/engine/getstarted/){: class="button outline-btn"}{% endcapture %}{{ basics | markdownify }}
[Start the basic tutorial](/engine/getstarted/){: class="button outline-btn"}
</div>
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-6 block">
{% capture apps %}
<div markdown="1" class="col-xs-12 col-sm-12 col-md-12 col-lg-6 block">
### Define and deploy apps in Swarm Mode
Learn how to relate containers to each other, define them as services, and
configure an application stack ready to deploy at scale in a production
environment. Highlights Compose Version 3 new features and swarm mode.
{% endcapture %}{{ apps | markdownify }}
{% capture apps %}[Start the application tutorial](/engine/getstarted-voting-app/){: class="button outline-btn"}{% endcapture %}{{ apps | markdownify }}
[Start the application tutorial](/engine/getstarted-voting-app/){: class="button outline-btn"}
</div>
</div>