Skip to content

Commit 2b330c4

Browse files
committed
Markdown lint
Signed-off-by: David Gageot <david@gageot.net>
1 parent c4e798c commit 2b330c4

File tree

4 files changed

+15
-16
lines changed

4 files changed

+15
-16
lines changed

docs/RELEASE.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,29 @@ several "checklist items" which should be documented. This document is intended
1212
to cover the current Docker Machine release process. It is written for Docker
1313
Machine core maintainers who might find themselves performing a release.
1414

15-
1. **Get a GITHUB_TOKEN** Check that you have a proper `GITHUB_TOKEN`. This
16-
token needs only to have the `repo` scope. The token can be created on github
17-
in the settings > Personal Access Token menu.
18-
1. **Run the release script** At the root of the project, run the following
15+
1. **Get a GITHUB_TOKEN** Check that you have a proper `GITHUB_TOKEN`. This
16+
token needs only to have the `repo` scope. The token can be created on github
17+
in the settings > Personal Access Token menu.
18+
2. **Run the release script** At the root of the project, run the following
1919
command `GITHUB_TOKEN=XXXX script/release.sh X.Y.Z` where `XXXX` is the
2020
value of the GITHUB_TOKEN generated, `X.Y.Z` the version to release
2121
( Explicitly excluding the 'v' prefix, the script takes care of it.). As of
2222
now, this version number must match the content of `version/version.go`. The
2323
script has been built to be as resilient as possible, cleaning everything
2424
it does along its way if necessary. You can run it many times in a row,
2525
fixing the various bits along the way.
26-
1. **Update the changelog on github** -- The script generated a list of all
27-
commits since last release. You need to edit this manually, getting rid of
28-
non critical details, and putting emphasis to what need our users attention.
29-
1. **Update the CHANGELOG.md** -- Add the same notes from the previous step to
26+
3. **Update the changelog on github** -- The script generated a list of all
27+
commits since last release. You need to edit this manually, getting rid of
28+
non critical details, and putting emphasis to what need our users attention.
29+
4. **Update the CHANGELOG.md** -- Add the same notes from the previous step to
3030
the `CHANGELOG.md` file in the repository.
31-
1. **Update the Documentation** -- Ensure that the `docs` branch on GitHub
31+
5. **Update the Documentation** -- Ensure that the `docs` branch on GitHub
3232
(which the Docker docs team uses to deploy from) is up to date with the
3333
changes to be deployed from the release branch / master.
34-
1. **Verify the Installation** -- Copy and paste the suggested commands in the
34+
6. **Verify the Installation** -- Copy and paste the suggested commands in the
3535
installation notes to ensure that they work properly. Best of all, grab an
3636
(uninvolved) buddy and have them try it. `docker-machine -v` should give
3737
them the released version once they have run the install commands.
38-
1. (Optional) **Drink a Glass of Wine** -- You've worked hard on this release.
38+
7. (Optional) **Drink a Glass of Wine** -- You've worked hard on this release.
3939
You deserve it. For wine suggestions, please consult your friendly
4040
neighborhood sommelier.

docs/drivers/aws.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ Environment variables and default values:
9999
| `--amazonec2-monitoring` | - | `false` |
100100
| `--amazonec2-use-ebs-optimized-instance` | - | `false` |
101101

102-
103102
## Security Group
104103

105104
Note that a security group will be created and associated to the host. This security group will have the following ports opened inbound :
@@ -110,4 +109,3 @@ Note that a security group will be created and associated to the host. This secu
110109

111110
If you specify a security group yourself using the `--amazonec2-security-group` flag, the above ports will be checked and opened and the security group modified.
112111
If you want more ports to be opened, like application specific ports, use the aws console and modify the configuration manually.
113-

docs/drivers/generic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Options:
3434
Environment variables and default values:
3535

3636
| CLI option | Environment variable | Default |
37-
|----------------------------|----------------------|---------------------------|
37+
| -------------------------- | -------------------- | ------------------------- |
3838
| **`--generic-ip-address`** | `GENERIC_IP_ADDRESS` | - |
3939
| `--generic-ssh-key` | `GENERIC_SSH_KEY` | _(defers to `ssh-agent`)_ |
4040
| `--generic-ssh-user` | `GENERIC_SSH_USER` | `root` |

docs/get-started-cloud.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,11 @@ Docker Machine drivers are available for several other cloud providers. For a fu
9595

9696
### Docker Machine command and driver reference
9797

98-
* `docker-machine` [create](https://docs.docker.com/machine/reference/create/) command
99-
* [Driver options and operating system defaults](https://docs.docker.com/machine/drivers/os-base/)
98+
- `docker-machine` [create](https://docs.docker.com/machine/reference/create/) command
99+
- [Driver options and operating system defaults](https://docs.docker.com/machine/drivers/os-base/)
100100

101101
### 3rd-party driver plugins
102+
102103
Several Docker Machine driver plugins for use with other cloud platforms are available from 3rd party contributors. These are use-at-your-own-risk plugins, not maintained by or formally associated with Docker.
103104

104105
See [Available driver plugins](https://github.com/docker/machine/blob/master/docs/AVAILABLE_DRIVER_PLUGINS.md) in the docker/machine repo on GitHub.

0 commit comments

Comments
 (0)