Skip to content

Commit 5bc8552

Browse files
committed
style: fix markdown linting errors in plan documents
1 parent 3dcd82e commit 5bc8552

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

.markdownlint-cli2.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ config:
33
line-length: false # MD013
44
no-duplicate-heading: false # MD024
55
reference-links-images: false # MD052
6-
no-multiple-blanks: false # MD032
6+
no-multiple-blanks:
7+
maximum: 2
78
ignores:
89
- .github/copilot-instructions.md
10+
- .windsurf/**

conductor/future_resources_plan.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This plan outlines the implementation of resources for Docker features that are currently unsupported in the `docker` cookbook, focusing on Swarm management and AI-native capabilities.
44

55
## Objective
6+
67
- Add support for core Swarm resources: `docker_secret` and `docker_config`.
78
- Add support for AI-native Docker features: `docker_model` and `docker_mcp`.
89
- Enhance `docker_container` to support `type=image` mounts.
@@ -11,37 +12,45 @@ This plan outlines the implementation of resources for Docker features that are
1112
## Proposed Resources
1213

1314
### 1. Swarm Management
15+
1416
- **`docker_secret`**: Manage Docker secrets (`docker secret create/rm/inspect`).
1517
- **`docker_config`**: Manage Docker configs (`docker config create/rm/inspect`).
1618

1719
### 2. AI & Model Management (Docker v28+)
20+
1821
- **`docker_model`**: Resource to pull and manage local LLMs using the new `docker model` CLI.
1922
- **`docker_mcp`**: Manage Model Context Protocol (MCP) servers and configurations.
2023

2124
### 3. Storage Enhancements
25+
2226
- **`docker_container` updates**: Add support for `image` type in the `mounts` property to leverage direct layer mounting.
2327

2428
### 4. Utility Resources
29+
2530
- **`docker_context`**: Manage Docker contexts for switching between local and remote engines.
2631

2732
## Implementation Steps
2833

2934
### Phase 1: Swarm Secrets and Configs
35+
3036
1. Create `resources/secret.rb`.
3137
2. Create `resources/config.rb`.
3238
3. Add corresponding unit tests in `spec/unit/resources/`.
3339
4. Add integration tests in a new `test/cookbooks/docker_test/recipes/swarm_resources.rb`.
3440

3541
### Phase 2: AI-Native Features
42+
3643
1. Research the `docker-api` gem's support for the new model and MCP endpoints.
3744
2. Implement `resources/model.rb` if CLI execution is required or API is available.
3845
3. Implement `resources/mcp.rb`.
3946

4047
### Phase 3: Container & Context
48+
4149
1. Update `resources/container.rb` properties.
4250
2. Create `resources/context.rb`.
4351

4452
## Verification & Testing
53+
4554
- **Unit Tests**: Ensure 100% coverage for new resources using ChefSpec.
4655
- **Integration Tests**: Expand Swarm suites to exercise secrets and configs.
4756
- **Documentation**: Add new files to `documentation/` for each resource.

conductor/modernization_plan.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
This plan outlines the steps to modernize the `docker` cookbook by removing EOL platforms, adding support for newer distributions, and cleaning up legacy code.
44

55
## Objective
6+
67
- Sync supported platforms across `metadata.rb`, Kitchen files, and CI.
78
- Remove EOL platforms (Ubuntu 20.04, Debian 11, AlmaLinux 8, Rocky Linux 8).
89
- Add support for new platforms (Debian 13, AlmaLinux 10, Rocky Linux 10).
910
- Remove legacy `sysvinit` and `upstart` templates.
1011
- Ensure all resources follow modern Sous Chefs patterns.
1112

1213
## Key Files & Context
14+
1315
- `metadata.rb`: Supported platforms and version.
1416
- `kitchen.yml`, `kitchen.dokken.yml`: Integration test platforms.
1517
- `.github/workflows/ci.yml`: CI matrix.
@@ -19,6 +21,7 @@ This plan outlines the steps to modernize the `docker` cookbook by removing EOL
1921
## Implementation Steps
2022

2123
### Phase 1: Platform Modernization
24+
2225
1. **Update `metadata.rb`**:
2326
- Refine `supports` to be more specific if possible, or ensure it accurately reflects the current state.
2427
- Update `chef_version` to `>= 16.0`.
@@ -32,6 +35,7 @@ This plan outlines the steps to modernize the `docker` cookbook by removing EOL
3235
- Sync the `integration` and `smoke` matrices with the updated kitchen platforms.
3336

3437
### Phase 2: Resource Updates
38+
3539
1. **Modernize `resources/installation_package.rb`**:
3640
- Add `trixie?` helper for Debian 13.
3741
- Update `version_string` to handle Debian 13.
@@ -41,18 +45,22 @@ This plan outlines the steps to modernize the `docker` cookbook by removing EOL
4145
- Delete `templates/default/upstart/` directory.
4246

4347
### Phase 3: Documentation & Maintenance
48+
4449
1. **Version Bump**: Increment version in `metadata.rb`.
4550
2. **Verify Docs**: Ensure Swarm resources and other new features are accurately documented in `documentation/`.
4651

4752
## Verification & Testing
4853

4954
### Unit Testing
55+
5056
- Run `chef exec rspec` to ensure all unit tests pass after changes.
5157
- Add or update specs for `installation_package` to cover Debian 13.
5258

5359
### Integration Testing
60+
5461
- Run `kitchen list` to verify updated platform list.
5562
- Run `kitchen test default-ubuntu-2404` (or other current platform) to ensure basic functionality.
5663

5764
### Linting
65+
5866
- Run `cookstyle -a` to fix any style offenses.

0 commit comments

Comments
 (0)