Gotea/docker-machine
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Hugo 15 support Markdown per GitHub; Removing seds

Browse Source 
Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony
2015-10-13 16:00:08 -07:00
parent d181f532c4
commit 1e7e241d9e
7 changed files with 71 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Dockerfile
View File

@@ -1,27 +1,17 @@
FROM docs/base:latest
FROM docs/base:hugo-github-linking
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/engine
RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm
RUN svn checkout https://github.com/docker/compose/trunk/docs /docs/content/compose
RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content/registry
RUN svn checkout https://github.com/kitematic/kitematic/trunk/docs /docs/content/kitematic
RUN svn checkout https://github.com/docker/tutorials/trunk/docs /docs/content/tutorials
RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content
# To get the git info for this repo
COPY . /src
COPY . /docs/content/machine/
RUN svn checkout https://github.com/docker/compose/trunk/docs /docs/content/compose
RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/docker
RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm
RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content/registry
RUN svn checkout https://github.com/docker/tutorials/trunk/docs /docs/content
RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content/opensource
RUN svn checkout https://github.com/kitematic/kitematic/trunk/docs /docs/content/kitematic
# Sed to process GitHub Markdown
# 1-2 Remove comment code from metadata block
# 3 Change ](/word to ](/project/ in links
# 4 Change ](word.md) to ](/project/word)
# 5 Remove .md extension from link text
# 6 Change ](../ to ](/project/word)
# 7 Change ](../../ to ](/project/ --> not implemented
#
#
RUN /src/pre-process.sh /docs

36
docs/README.md
View File

@@ -1,8 +1,8 @@
# Contributing to the Docker Compose documentation
# Contributing to the Docker Machine documentation
The documentation in this directory is part of the [this documentation](docs.docker.com). Docker uses [the Hugo static generator](http://gohugo.io/overview/introduction/) to convert project Markdown files to a static HTML site.
The documentation in this directory is part of the [this documentation](https://docs.docker.com). Docker uses [the Hugo static generator](http://gohugo.io/overview/introduction/) to convert project Markdown files to a static HTML site.
You don't need to be a Hugo expert to contribute to the compose documentation. If you are familiar with Markdown, you can modify the content in the `docs` files.
You don't need to be a Hugo expert to contribute to the machine documentation. If you are familiar with Markdown, you can modify the content in the `docs` files.
If you want to add a new file or change the location of the document in the menu, you do need to know a little more. If you want the detail of contributing, [use our contributor guide](http://docs.docker.com/project/make-a-contribution/).
@@ -27,7 +27,7 @@ If you want to add a new file or change the location of the document in the menu
docker run --rm -it -e AWS_S3_BUCKET -e NOCACHE -p 8000:8000 -e DOCKERHOST "docs-base:test-tooling" hugo server --port=8000 --baseUrl=192.168.59.103 --bind=0.0.0.0
ERROR: 2015/06/13 MenuEntry's .Url is deprecated and will be removed in Hugo 0.15. Use .URL instead.
0 of 4 drafts rendered
0 future content
0 future content
12 pages created
0 paginator pages created
0 tags created
@@ -39,21 +39,21 @@ If you want to add a new file or change the location of the document in the menu
5. Open the available server in your browser.
The documentation server has the complete menu but only the Docker Compose
The documentation server has the complete menu but only the Docker machine
documentation resolves. You can't access the other project docs from this
localized build.
## Tips on Hugo metadata and menu positioning
The top of each Docker Compose documentation file contains TOML metadata. The metadata is commented out to prevent it from appearing in GitHub.
The top of each Docker machine documentation file contains TOML metadata. The metadata is commented out to prevent it from appearing in GitHub.
<!--[metadata]>
+++
title = "Extending services in Compose"
description = "How to use Docker Compose's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, compose, docker, orchestration, documentation, docs"]
title = "Extending services in machine"
description = "How to use Docker machine's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"]
[menu.main]
parent="smn_workw_compose"
parent="smn_workw_machine"
weight=2
+++
<![end-metadata]-->
@@ -61,21 +61,21 @@ The top of each Docker Compose documentation file contains TOML metadata. The me
The metadata alone has this structure:
+++
title = "Extending services in Compose"
description = "How to use Docker Compose's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, compose, docker, orchestration, documentation, docs"]
title = "Extending services in machine"
description = "How to use Docker machine's extends keyword to share configuration between files and projects"
keywords = ["fig, composition, machine, docker, orchestration, documentation, docs"]
[menu.main]
parent="smn_workw_compose"
parent="smn_workw_machine"
weight=2
+++
The `[menu.main]` section refers to navigation defined [in the main Docker menu](https://github.com/docker/docs-base/blob/hugo/config.toml). This metadata says *add a menu item called* Extending services in Compose *to the menu with the* `smn_workdw_compose` *identifier*. If you locate the menu in the configuration, you'll find *Create multi-container applications* is the menu title.
The `[menu.main]` section refers to navigation defined [in the main Docker menu](https://github.com/docker/docs-base/blob/hugo/config.toml). This metadata says *add a menu item called* Extending services in machine *to the menu with the* `smn_workdw_machine` *identifier*. If you locate the menu in the configuration, you'll find *Create multi-container applications* is the menu title.
You can move an article in the tree by specifying a new parent. You can shift the location of the item by changing its weight. Higher numbers are heavier and shift the item to the bottom of menu. Low or no numbers shift it up.
## Other key documentation repositories
The `docker/docs-base` repository contains [the Hugo theme and menu configuration](https://github.com/docker/docs-base). If you open the `Dockerfile` you'll see the `make docs` relies on this as a base image for building the Compose documentation.
The `docker/docs-base` repository contains [the Hugo theme and menu configuration](https://github.com/docker/docs-base). If you open the `Dockerfile` you'll see the `make docs` relies on this as a base image for building the machine documentation.
The `docker/docs.docker.com` repository contains [build system for building the Docker documentation site](https://github.com/docker/docs.docker.com). Fork this repository to build the entire documentation site.

28
docs/drivers/index.md
View File

@@ -11,17 +11,17 @@ identifier="smn_machine_drivers"
# Supported Drivers
* [Amazon Web Services](/drivers/aws.md)
* [Microsoft Azure](/drivers/azure.md)
* [Digital Ocean](/drivers/digital-ocean.md)
* [Exoscale](/drivers/exoscale.md)
* [Google Compute Engine](/drivers/gce.md)
* [Generic](/drivers/generic.md)
* [Microsoft Hyper-V](/drivers/hyper-v.md)
* [OpenStack](/drivers/openstack.md)
* [Rackspace](/drivers/rackspace.md)
* [IBM Softlayer](/drivers/soft-layer.md)
* [Oracle VirtualBox](/drivers/virtualbox.md)
* [VMware vCloud Air](/drivers/vm-cloud.md)
* [VMware Fusion](/drivers/vm-fusion.md)
* [VMware vSphere](/drivers/vsphere.md)
* [Amazon Web Services](aws.md)
* [Microsoft Azure](azure.md)
* [Digital Ocean](digital-ocean.md)
* [Exoscale](exoscale.md)
* [Google Compute Engine](gce.md)
* [Generic](generic.md)
* [Microsoft Hyper-V](hyper-v.md)
* [OpenStack](openstack.md)
* [Rackspace](rackspace.md)
* [IBM Softlayer](soft-layer.md)
* [Oracle VirtualBox](virtualbox.md)
* [VMware vCloud Air](vm-cloud.md)
* [VMware Fusion](vm-fusion.md)
* [VMware vSphere](vsphere.md)

4
docs/drivers/os-base.md
View File

@@ -28,7 +28,7 @@ $ docker-machine create -d azure --azure-subscription-id="SUB_ID" --azure-subscr
```
To see a list of providers and review the options available to a provider, see
the [Docker Machine driver reference](/drivers).
the [Docker Machine driver reference](../index.md).
In addition to the provider, you have the option of identifying a base operating
system. It is an option because Docker Machine has defaults for both local and
@@ -54,4 +54,4 @@ provider's image flag and one of its available images. For example, to select a
If you change the base image for a provider, you may also need to change
the SSH user. For example, the default Red Hat AMI on EC2 expects the
SSH user to be `ec2-user`, so you would have to specify this with
`--amazonec2-ssh-user ec2-user`.
`--amazonec2-ssh-user ec2-user`.

10
docs/index.md
View File

@@ -34,9 +34,9 @@ Machine on Linux or for installing Machine alone without Docker Toolbox, see the
Docker Machine allows you to provision Docker on virtual machines that reside either on your local system or on a cloud provider. Docker Machine creates a host on a VM and you use the Docker Engine client as needed to build images and create containers on the host.
To create a virtual machine, you supply Docker Machine with the name of the driver you want use. The driver represents the virtual environment. For example, on a local Linux, Mac, or Windows system the driver is typically Oracle Virtual Box. For cloud providers, Docker Machine supports drivers such as AWS, Microsoft Azure, Digital Ocean and many more. The Docker Machine reference includes a complete [list of the supported drivers](/drivers).
To create a virtual machine, you supply Docker Machine with the name of the driver you want use. The driver represents the virtual environment. For example, on a local Linux, Mac, or Windows system the driver is typically Oracle Virtual Box. For cloud providers, Docker Machine supports drivers such as AWS, Microsoft Azure, Digital Ocean and many more. The Docker Machine reference includes a complete [list of the supported drivers](drivers/index.md).
Since Docker runs on Linux, each VM that Docker Machine provisions relies on a base operating system. For convenience, there are default base operating systems. For the Oracle Virtual Box driver, this base operating system is the `boot2docker.iso`. For drivers used to connect to cloud providers, the base operating system is Ubuntu 12.04+. You can change this default when you create a machine. The Docker Machine reference includes a complete [list of the supported operating systems](/drivers/os-base).
Since Docker runs on Linux, each VM that Docker Machine provisions relies on a base operating system. For convenience, there are default base operating systems. For the Oracle Virtual Box driver, this base operating system is the `boot2docker.iso`. For drivers used to connect to cloud providers, the base operating system is Ubuntu 12.04+. You can change this default when you create a machine. The Docker Machine reference includes a complete [list of the supported operating systems](drivers/os-base.md).
For each machine you create, the Docker host address is the IP address of the
Linux VM. This address is assigned by the `docker-machine create` subcommand.
@@ -48,7 +48,7 @@ command-line to point to that machine. The `docker-machine env <machine-name>`
subcommand outputs the configuration command you should use. When you run a
container on the Docker host, the container's ports map to ports on the VM.
For a complete list of the `docker-machine` subcommands, see the [Docker Machine subcommand reference](/reference).
For a complete list of the `docker-machine` subcommands, see the [Docker Machine subcommand reference](reference/index.md).
## Getting help
@@ -70,5 +70,5 @@ For more information and resources, please visit
* Install a machine on your [local system using VirtualBox](get-started.md).
* Install multiple machines [on your cloud provider](get-started-cloud.md).
* [Docker Machine driver reference](/drivers)
* [Docker Machine subcommand reference](/reference)
* [Docker Machine driver reference](drivers/index.md)
* [Docker Machine subcommand reference](reference/index.md)

4
docs/install-machine.md
View File

@@ -75,5 +75,5 @@ Github](https://github.com/docker/machine/releases/). To install from a binary:
## Where to go next
* [Docker Machine overview](/)
* [Docker Machine driver reference](/drivers)
* [Docker Machine subcommand reference](/reference)
* [Docker Machine driver reference](drivers/index.md)
* [Docker Machine subcommand reference](reference/index.md)

38
docs/reference/index.md
View File

@@ -12,22 +12,22 @@ parent="smn_machine_ref"
# Supported Docker Machine subcommands
* [active](/reference/active.md)
* [config](/reference/config.md)
* [create](/reference/create.md)
* [env](/reference/env.md)
* [help](/reference/help.md)
* [inspect](/reference/inspect.md)
* [ip](/reference/ip.md)
* [kill](/reference/kill.md)
* [ls](/reference/ls.md)
* [regenerate-certs](/reference/regenerate-certs.md)
* [restart](/reference/restart.md)
* [rm](/reference/rm.md)
* [scp](/reference/scp.md)
* [ssh](/reference/ssh.md)
* [start](/reference/start.md)
* [status](/reference/status.md)
* [stop](/reference/stop.md)
* [upgrade](/reference/upgrade.md)
* [url](/reference/url.md)
* [active](active.md)
* [config](config.md)
* [create](create.md)
* [env](env.md)
* [help](help.md)
* [inspect](inspect.md)
* [ip](ip.md)
* [kill](kill.md)
* [ls](ls.md)
* [regenerate-certs](regenerate-certs.md)
* [restart](restart.md)
* [rm](rm.md)
* [scp](scp.md)
* [ssh](ssh.md)
* [start](start.md)
* [status](status.md)
* [stop](stop.md)
* [upgrade](upgrade.md)
* [url](url.md)