Skip to content

Commit 53f6795

Browse files
committed
fix: satisfy markdown and cookstyle lint
1 parent 34508dc commit 53f6795

8 files changed

Lines changed: 197 additions & 193 deletions

File tree

.github/instructions/project.instructions.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ The **Percona cookbook** installs and configures Percona MySQL client and/or ser
88

99
### Recipes (Primary Interface)
1010

11-
- `percona` (default) - Includes client recipe
12-
- `percona::client` - Installs Percona MySQL client libraries
13-
- `percona::server` - Installs and configures Percona MySQL server
14-
- `percona::backup` - Installs Percona XtraBackup hot backup software
15-
- `percona::toolkit` - Installs Percona Toolkit command-line tools
16-
- `percona::cluster` - Sets up XtraDB Cluster for high availability
17-
- `percona::package_repo` - Sets up package repository
18-
- `percona::replication` - Configures MySQL replication
19-
- `percona::ssl` - Configures SSL certificates
11+
* `percona` (default) - Includes client recipe
12+
* `percona::client` - Installs Percona MySQL client libraries
13+
* `percona::server` - Installs and configures Percona MySQL server
14+
* `percona::backup` - Installs Percona XtraBackup hot backup software
15+
* `percona::toolkit` - Installs Percona Toolkit command-line tools
16+
* `percona::cluster` - Sets up XtraDB Cluster for high availability
17+
* `percona::package_repo` - Sets up package repository
18+
* `percona::replication` - Configures MySQL replication
19+
* `percona::ssl` - Configures SSL certificates
2020

2121
### Custom Resources
2222

23-
- `percona_mysql_database` - Manages MySQL databases
24-
- `percona_mysql_user` - Manages MySQL users and grants
23+
* `percona_mysql_database` - Manages MySQL databases
24+
* `percona_mysql_user` - Manages MySQL users and grants
2525

2626
### Supported Versions & Platforms
2727

@@ -70,56 +70,56 @@ end
7070

7171
### Test Kitchen Suites
7272

73-
- `client-56` - Tests client installation with Percona 5.6
74-
- `server-56` - Tests server installation with Percona 5.6
75-
- `server-80` - Tests server installation with Percona 8.0
76-
- `cluster` - Tests XtraDB Cluster setup
73+
* `client-56` - Tests client installation with Percona 5.6
74+
* `server-56` - Tests server installation with Percona 5.6
75+
* `server-80` - Tests server installation with Percona 8.0
76+
* `cluster` - Tests XtraDB Cluster setup
7777

7878
### Test Fixtures
7979

8080
Located in `test/fixtures/cookbooks/test/` - demonstrates proper cookbook usage patterns including:
8181

82-
- Client-only installations
83-
- Server configurations
84-
- Cluster setups
85-
- Database and user management examples
82+
* Client-only installations
83+
* Server configurations
84+
* Cluster setups
85+
* Database and user management examples
8686

8787
### Data Bags Required
8888

8989
Test data bags in `test/integration/data_bags/` for:
9090

91-
- MySQL root passwords
92-
- Application database credentials
93-
- SSL certificate data
91+
* MySQL root passwords
92+
* Application database credentials
93+
* SSL certificate data
9494

9595
## Platform-Specific Behavior
9696

9797
### Debian/Ubuntu
9898

99-
- Socket: `/var/run/mysqld/mysqld.sock`
100-
- PID: `/var/run/mysqld/mysqld.pid`
101-
- Include dir: `/etc/mysql/conf.d/`
102-
- Storage engine: `InnoDB` (capitalized)
99+
* Socket: `/var/run/mysqld/mysqld.sock`
100+
* PID: `/var/run/mysqld/mysqld.pid`
101+
* Include dir: `/etc/mysql/conf.d/`
102+
* Storage engine: `InnoDB` (capitalized)
103103

104104
### RHEL/CentOS
105105

106-
- Socket: `/var/lib/mysql/mysql.sock`
107-
- PID: `/var/lib/mysql/mysqld.pid`
108-
- Include dir: `` (empty)
109-
- Storage engine: `innodb` (lowercase)
106+
* Socket: `/var/lib/mysql/mysql.sock`
107+
* PID: `/var/lib/mysql/mysqld.pid`
108+
* Include dir: `` (empty)
109+
* Storage engine: `innodb` (lowercase)
110110

111111
## Dependencies
112112

113113
### Required Cookbooks
114114

115-
- `yum` - Package management for RHEL platforms
116-
- `yum-epel` - EPEL repository for additional packages
117-
- `line` - File editing utilities
115+
* `yum` - Package management for RHEL platforms
116+
* `yum-epel` - EPEL repository for additional packages
117+
* `line` - File editing utilities
118118

119119
### External Dependencies
120120

121-
- Percona APT/YUM repositories (managed by `package_repo` recipe)
122-
- Internet access for package downloads during convergence
121+
* Percona APT/YUM repositories (managed by `package_repo` recipe)
122+
* Internet access for package downloads during convergence
123123

124124
## Common Issues
125125

@@ -133,9 +133,9 @@ Set `node['percona']['selinux_module_url']` if custom SELinux policies are neede
133133

134134
### Version Compatibility
135135

136-
- Percona 8.0 requires different configuration patterns than 5.7
137-
- Test both versions when making changes to server recipes
138-
- XtraDB Cluster configuration varies significantly between versions
136+
* Percona 8.0 requires different configuration patterns than 5.7
137+
* Test both versions when making changes to server recipes
138+
* XtraDB Cluster configuration varies significantly between versions
139139

140140
## Development Notes
141141

.markdownlint-cli2.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ config:
33
line-length: false # MD013
44
no-duplicate-heading: false # MD024
55
reference-links-images: false # MD052
6+
ul-style:
7+
style: asterisk
68
no-multiple-blanks:
79
maximum: 2
810
ignores:
911
- .github/copilot-instructions.md
12+
- .windsurf/**

.rubocop.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
AllCops:
33
Exclude:
44
- 'Dangerfile'
5+
- 'vendor/**/*'

0 commit comments

Comments
 (0)