Skip to content

Commit b9e57a3

Browse files
damacusdamacus
authored
fix(docs): Fix markdown (#1329)
Signed-off-by: Dan Webb <[email protected]>
1 parent ea4caa4 commit b9e57a3

File tree

6 files changed

+69
-70
lines changed

6 files changed

+69
-70
lines changed

‎CHANGELOG.md‎

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [11.10.2](https://github.com/sous-chefs/docker/compare/11.10.1...v11.10.2) (2025-10-15)
99

10-
1110
### Bug Fixes
1211

1312
* **ci:** Update workflows to use release pipeline ([#1320](https://github.com/sous-chefs/docker/issues/1320)) ([5fce840](https://github.com/sous-chefs/docker/commit/5fce84023bac5499c9552cd295dddcab2504ed9c))
@@ -33,10 +32,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3332

3433
* Add Docker Swarm support
3534
New resources:
36-
- docker_swarm_init
37-
- docker_swarm_join
38-
- docker_swarm_service
39-
- docker_swarm_token
35+
* docker_swarm_init
36+
* docker_swarm_join
37+
* docker_swarm_service
38+
* docker_swarm_token
4039

4140
## 11.8.4 - *2024-12-11*
4241

@@ -54,15 +53,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5453
## 11.8.2 - *2024-12-11*
5554

5655
* Enhance tmpfs support for containers
57-
- Added support for array format in tmpfs property
58-
- Improved documentation with examples
59-
- Added test coverage for tmpfs functionality
56+
* Added support for array format in tmpfs property
57+
* Improved documentation with examples
58+
* Added test coverage for tmpfs functionality
6059

6160
## 11.8.1 - *2024-12-11*
6261

6362
* Fix issue with container network mode causing unnecessary redeployment when using `container:<name>` format
64-
- Added network mode normalization to handle container IDs consistently
65-
- Prevents container recreation when only the container ID format changes
63+
* Added network mode normalization to handle container IDs consistently
64+
* Prevents container recreation when only the container ID format changes
6665

6766
## 11.8.0 - *2024-12-11*
6867

@@ -134,15 +133,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
134133

135134
The following resources are now custom resources:
136135

137-
- `docker_installation`
138-
- `docker_installation_package`
139-
- `docker_installation_script`
140-
- `docker_installation_tarball`
141-
- `docker_service`
142-
- `docker_service_base`
143-
- `docker_service_manager`
144-
- `docker_service_manager_execute`
145-
- `docker_service_manager_systemd`
136+
* `docker_installation`
137+
* `docker_installation_package`
138+
* `docker_installation_script`
139+
* `docker_installation_tarball`
140+
* `docker_service`
141+
* `docker_service_base`
142+
* `docker_service_manager`
143+
* `docker_service_manager_execute`
144+
* `docker_service_manager_systemd`
146145

147146
This means their classes are no longer in the `DockerCookbook` module.
148147

@@ -252,7 +251,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
252251
## 10.0.0 - *2021-10-20*
253252

254253
* Remove the sysvinit Docker Service managers
255-
- Platforms that supported these service managers are now EOL
254+
* Platforms that supported these service managers are now EOL
256255

257256
## 9.11.0 - *2021-10-20*
258257

@@ -349,7 +348,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
349348
## 8.0.0 - *2021-08-25*
350349

351350
* Remove upstart docker service manage
352-
- We don't officialy support any distros that use upstart anymore
351+
* We don't officialy support any distros that use upstart anymore
353352

354353
## 7.7.8 - *2021-08-25
355354

@@ -477,18 +476,18 @@ The 7.0 release includes a breaking change to package installs with version spec
477476

478477
* Standardise files with files in chef-cookbooks/repo-management - [@xorimabot](https://github.com/xorimabot)
479478
* Resolved deprecations to provide Chef Infra Client 16 compatibility - [@xorimabot](https://github.com/xorimabot)
480-
- resolved cookstyle error: libraries/docker_container.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
481-
- resolved cookstyle error: libraries/docker_exec.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
482-
- resolved cookstyle error: libraries/docker_image.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
483-
- resolved cookstyle error: libraries/docker_image_prune.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
484-
- resolved cookstyle error: libraries/docker_installation_package.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
485-
- resolved cookstyle error: libraries/docker_installation_tarball.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
486-
- resolved cookstyle error: libraries/docker_network.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
487-
- resolved cookstyle error: libraries/docker_plugin.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
488-
- resolved cookstyle error: libraries/docker_registry.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
489-
- resolved cookstyle error: libraries/docker_service_manager_execute.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
490-
- resolved cookstyle error: libraries/docker_tag.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
491-
- resolved cookstyle error: libraries/docker_volume.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
479+
* resolved cookstyle error: libraries/docker_container.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
480+
* resolved cookstyle error: libraries/docker_exec.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
481+
* resolved cookstyle error: libraries/docker_image.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
482+
* resolved cookstyle error: libraries/docker_image_prune.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
483+
* resolved cookstyle error: libraries/docker_installation_package.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
484+
* resolved cookstyle error: libraries/docker_installation_tarball.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
485+
* resolved cookstyle error: libraries/docker_network.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
486+
* resolved cookstyle error: libraries/docker_plugin.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
487+
* resolved cookstyle error: libraries/docker_registry.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
488+
* resolved cookstyle error: libraries/docker_service_manager_execute.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
489+
* resolved cookstyle error: libraries/docker_tag.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
490+
* resolved cookstyle error: libraries/docker_volume.rb:3:5 warning: `ChefDeprecations/ResourceUsesOnlyResourceName`
492491

493492
## 6.0.1 (2020-05-26)
494493

‎documentation/docker_installation_package.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ The `docker_installation_package` resource is responsible for installing Docker
99

1010
## Properties
1111

12-
| Property | Type | Default | Description |
13-
|------------------|---------|------------------------|------------------------------------------------------------|
14-
| `setup_docker_repo` | Boolean | `true` | Whether to set up the Docker repository |
15-
| `repo_channel` | String | `'stable'` | Repository channel to use (`stable`, `test`, `nightly`) |
16-
| `package_name` | String | `'docker-ce'` | Name of the Docker package to install |
17-
| `package_version` | String | `nil` | Specific package version to install |
18-
| `version` | String | `nil` | Docker version to install (e.g., '20.10.23') |
19-
| `package_options` | String | `nil` | Additional options to pass to the package manager |
20-
| `site_url` | String | `'download.docker.com'`| Docker repository URL |
12+
| Property | Type | Default | Description |
13+
|---------------------|---------|-------------------------|---------------------------------------------------------|
14+
| `setup_docker_repo` | Boolean | `true` | Whether to set up the Docker repository |
15+
| `repo_channel` | String | `'stable'` | Repository channel to use (`stable`, `test`, `nightly`) |
16+
| `package_name` | String | `'docker-ce'` | Name of the Docker package to install |
17+
| `package_version` | String | `nil` | Specific package version to install |
18+
| `version` | String | `nil` | Docker version to install (e.g., '20.10.23') |
19+
| `package_options` | String | `nil` | Additional options to pass to the package manager |
20+
| `site_url` | String | `'download.docker.com'` | Docker repository URL |
2121

2222
## Examples
2323

‎documentation/docker_installation_script.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ The `docker_installation_script` resource installs Docker on Linux systems using
99

1010
## Properties
1111

12-
| Property | Type | Default | Description |
13-
|-------------|--------|----------------|-----------------------------------------------------------------------|
14-
| `repo` | String | `'main'` | Repository to use for installation. One of: `main`, `test`, or `experimental` |
15-
| `script_url`| String | Based on repo | URL of the installation script. Defaults to official Docker URLs based on the repo property |
12+
| Property | Type | Default | Description |
13+
|--------------|--------|---------------|---------------------------------------------------------------------------------------------|
14+
| `repo` | String | `'main'` | Repository to use for installation. One of: `main`, `test`, or `experimental` |
15+
| `script_url` | String | Based on repo | URL of the installation script. Defaults to official Docker URLs based on the repo property |
1616

1717
## Examples
1818

‎documentation/docker_installation_tarball.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ The `docker_installation_tarball` resource installs Docker on a system using pre
99

1010
## Properties
1111

12-
| Property | Type | Default | Description |
13-
|------------|--------|-------------------|--------------------------------------------|
14-
| `checksum` | String | Based on version | SHA256 checksum of the Docker tarball |
15-
| `source` | String | Based on version | URL of the Docker tarball |
16-
| `channel` | String | `'stable'` | Docker release channel to use |
17-
| `version` | String | `'20.10.11'` | Docker version to install |
12+
| Property | Type | Default | Description |
13+
|------------|--------|------------------|---------------------------------------|
14+
| `checksum` | String | Based on version | SHA256 checksum of the Docker tarball |
15+
| `source` | String | Based on version | URL of the Docker tarball |
16+
| `channel` | String | `'stable'` | Docker release channel to use |
17+
| `version` | String | `'20.10.11'` | Docker version to install |
1818

1919
## Examples
2020

‎documentation/docker_service_manager_execute.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The `docker_service_manager_execute` resource manages the Docker daemon using Ch
1212

1313
This resource inherits properties from the `docker_service_base` resource. Common properties include:
1414

15-
| Property | Type | Default | Description |
16-
|-------------------|--------|------------|------------------------------------------------|
17-
| `docker_daemon_cmd`| String | Generated | Command to start the Docker daemon |
18-
| `logfile` | String | Based on name | Path to the log file |
19-
| `pidfile` | String | Based on name | Path to the PID file |
20-
| `http_proxy` | String | `nil` | HTTP proxy settings |
21-
| `https_proxy` | String | `nil` | HTTPS proxy settings |
22-
| `no_proxy` | String | `nil` | No proxy settings |
23-
| `tmpdir` | String | `nil` | Temporary directory path |
15+
| Property | Type | Default | Description |
16+
|---------------------|--------|---------------|------------------------------------|
17+
| `docker_daemon_cmd` | String | Generated | Command to start the Docker daemon |
18+
| `logfile` | String | Based on name | Path to the log file |
19+
| `pidfile` | String | Based on name | Path to the PID file |
20+
| `http_proxy` | String | `nil` | HTTP proxy settings |
21+
| `https_proxy` | String | `nil` | HTTPS proxy settings |
22+
| `no_proxy` | String | `nil` | No proxy settings |
23+
| `tmpdir` | String | `nil` | Temporary directory path |
2424

2525
## Examples
2626

‎documentation/docker_service_manager_systemd.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The `docker_service_manager_systemd` resource manages the Docker daemon using sy
1212

1313
This resource inherits properties from the `docker_service_base` resource. Common properties include:
1414

15-
| Property | Type | Default | Description |
16-
|-------------------|---------|------------|--------------------------------------------------|
17-
| `docker_daemon_cmd`| String | Generated | Command to start the Docker daemon |
18-
| `docker_name` | String | `'docker'` | Name of the Docker service |
19-
| `connect_socket` | String | `nil` | Docker socket path |
20-
| `docker_containerd`| Boolean | - | Whether to use containerd |
21-
| `env_vars` | Hash | `{}` | Environment variables for the Docker daemon |
22-
| `systemd_socket_args`| Hash | `{}` | Additional systemd socket arguments |
23-
| `systemd_args` | Hash | `{}` | Additional systemd service arguments |
15+
| Property | Type | Default | Description |
16+
|-----------------------|---------|------------|---------------------------------------------|
17+
| `docker_daemon_cmd` | String | Generated | Command to start the Docker daemon |
18+
| `docker_name` | String | `'docker'` | Name of the Docker service |
19+
| `connect_socket` | String | `nil` | Docker socket path |
20+
| `docker_containerd` | Boolean | - | Whether to use containerd |
21+
| `env_vars` | Hash | `{}` | Environment variables for the Docker daemon |
22+
| `systemd_socket_args` | Hash | `{}` | Additional systemd socket arguments |
23+
| `systemd_args` | Hash | `{}` | Additional systemd service arguments |
2424

2525
## Examples
2626

0 commit comments

Comments
 (0)
⚡