Skip to content

Commit b941d2a

Browse files
committed
fix(security): fix markdown linting issues in documentation
- Wrap bare URLs in markdown link syntax - Add language specifiers to code blocks (bash for commands) - Convert bold emphasis to proper markdown headings - Fix list formatting and indentation - Correct grammar: 'grades is' -> 'grades are' Addresses code review nitpick comments for security plugin docs.
1 parent aae0bb9 commit b941d2a

File tree

4 files changed

+41
-34
lines changed

4 files changed

+41
-34
lines changed

plugins/security/README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Security plugin provides automated vulnerability grade assessment for contai
88

99
**Key capabilities:**
1010
- **Container vulnerability grading** using Red Hat Pyxis API
11-
- **Multi-architecture support** (amd64, arm64, ppc64le, s390x)
11+
- - **Multi-architecture support** (amd64, arm64, ppc64le, s390x)
1212
- **Release-based tracking** for OSSM and other Red Hat products
1313
- **Automated reporting** with grade-focused summaries
1414
- **Corporate environment compatibility** with Kerberos authentication
@@ -91,7 +91,7 @@ Summary: 2 repositories | Grades: 1×B, 1×C
9191
### Prerequisites
9292

9393
1. **Container Grade Reporter Tool**
94-
- Clone from: https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter
94+
- Clone from: [container-grade-reporter](https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter)
9595
- Requires Red Hat internal network access
9696

9797
2. **Kerberos Authentication**
@@ -106,7 +106,7 @@ Summary: 2 repositories | Grades: 1×B, 1×C
106106

107107
### Setup
108108

109-
**Step 1: Install Security Plugin**
109+
#### Step 1: Install Security Plugin
110110

111111
```bash
112112
# Add ai-helpers marketplace
@@ -116,22 +116,22 @@ Summary: 2 repositories | Grades: 1×B, 1×C
116116
/plugin install security@ai-helpers
117117
```
118118

119-
**Step 2: Clone Container Grade Reporter**
119+
#### Step 2: Clone Container Grade Reporter
120120

121121
```bash
122122
# Clone to your preferred location
123123
cd ~/Code
124124
git clone https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter.git
125125
```
126126

127-
**Step 3: Configure Tool Path**
127+
#### Step 3: Configure Tool Path
128128

129129
```bash
130130
# Set the tool location
131131
/security:set-image-grade-tool-path ~/Code/container-grade-reporter
132132
```
133133

134-
**Step 4: Verify Keytab**
134+
#### Step 4: Verify Keytab
135135

136136
Ensure your keytab file is available:
137137
```bash
@@ -302,12 +302,14 @@ The vulnerability grading system uses Red Hat's A-F scale:
302302
The plugin displays architecture information for each container image:
303303

304304
**Grouped architectures** (when all have same grade/version):
305+
305306
```
306307
openshift-service-mesh/istio-cni-rhel9
307308
1.26 → Grade: B ✅ | v1.26.5 | amd64,arm64,ppc64le,s390x | End: 2025-08-22
308309
```
309310
310311
**Separate architectures** (when grades/versions differ):
312+
311313
```
312314
openshift-service-mesh/example-repo
313315
2.6 → Grade: B ✅ | v2.6.5 | amd64 | End: 2025-08-20
@@ -328,6 +330,7 @@ Error: Container Grade Reporter not found
328330
```
329331
330332
**Solutions:**
333+
331334
1. Clone the repository: `git clone https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter.git`
332335
2. Configure path: `/security:set-image-grade-tool-path /path/to/container-grade-reporter`
333336
3. Or clone into workspace: `./container-grade-reporter/`
@@ -339,6 +342,7 @@ Error: Kerberos authentication failed
339342
```
340343
341344
**Solutions:**
345+
342346
1. Verify keytab exists: `ls ~/ossm-report-sa.keytab`
343347
2. Check keytab is base64 encoded
344348
3. Test manual authentication: `kinit -kt ~/keytab your-principal@IPA.REDHAT.COM`
@@ -351,6 +355,7 @@ Error: Cannot connect to pyxis.engineering.redhat.com
351355
```
352356
353357
**Solutions:**
358+
354359
1. Connect to Red Hat VPN
355360
2. Verify network access: `curl -k https://pyxis.engineering.redhat.com/v1/`
356361
3. Check proxy configuration
@@ -362,6 +367,7 @@ Error: Invalid YAML configuration file
362367
```
363368
364369
**Solutions:**
370+
365371
1. Validate YAML syntax: `python -c "import yaml; yaml.safe_load(open('config.yaml'))"`
366372
2. Check indentation (use spaces, not tabs)
367373
3. Verify structure matches releases/components format
@@ -373,6 +379,7 @@ Error: Python 3.12 not found
373379
```
374380
375381
**Solutions:**
382+
376383
1. Install Python 3.12: `sudo dnf install python3.12`
377384
2. Or use available Python 3.x (Makefile will fallback automatically)
378385
@@ -465,10 +472,10 @@ Potential enhancements:
465472

466473
## Support
467474

468-
- **Issues**: https://github.com/openshift-eng/ai-helpers/issues
475+
- **Issues**: [openshift-eng/ai-helpers/issues](https://github.com/openshift-eng/ai-helpers/issues)
469476
- **Documentation**: ai-helpers repository README and AGENTS.md
470477
- **Authentication**: Contact Red Hat IT for keytab and API access
471-
- **Tool Repository**: https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter
478+
- **Tool Repository**: [container-grade-reporter](https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter)
472479

473480
## License
474481

plugins/security/commands/image-grades.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ The command uses the container-grade-reporter tool which must be installed and c
6767
```
6868

6969
**With `--email` (send email report):**
70-
70+
7171
Without grade filter:
7272
```bash
7373
cd <tool-path>
7474
make email CONFIG=<absolute-config-path>
7575
```
76-
76+
7777
With grade filter:
7878
```bash
7979
cd <tool-path>
@@ -286,48 +286,48 @@ HTML report saved: /tmp/security-image-grades-20251110-154523/vulnerability_repo
286286
## Examples
287287

288288
1. **Generate report for OSSM releases**:
289-
```
289+
```bash
290290
/security:image-grades ~/ossm-releases.yaml
291291
```
292292

293293
2. **Generate report with specific configuration**:
294-
```
294+
```bash
295295
/security:image-grades ./configs/ossm-3.1.yaml
296296
```
297297

298298
3. **Generate report after setting tool path**:
299-
```
299+
```bash
300300
/security:set-image-grade-tool-path ~/Code/container-grade-reporter
301301
/security:image-grades ./my-releases.yaml
302302
```
303303

304304
4. **Filter by specific grade**:
305-
```
305+
```bash
306306
/security:image-grades ~/releases.yaml --grade b
307307
```
308308

309309
5. **Filter by multiple grades**:
310-
```
310+
```bash
311311
/security:image-grades ~/releases.yaml --grade c,d,f
312312
```
313313

314314
6. **Check for critical vulnerabilities only**:
315-
```
315+
```bash
316316
/security:image-grades ./configs/ossm-3.1.yaml --grade d,f
317317
```
318318

319319
7. **Send email report**:
320-
```
320+
```bash
321321
/security:image-grades ~/releases.yaml --email
322322
```
323323

324324
8. **Send filtered email report**:
325-
```
325+
```bash
326326
/security:image-grades ~/releases.yaml --grade c,d,f --email
327327
```
328328

329329
9. **Email only critical vulnerabilities to team**:
330-
```
330+
```bash
331331
/security:image-grades ./configs/ossm-3.1.yaml --grade d,f --email
332332
```
333333

@@ -340,7 +340,7 @@ HTML report saved: /tmp/security-image-grades-20251110-154523/vulnerability_repo
340340

341341
- **$2**: Grade filter (optional)
342342
- Required: No
343-
- Format: `--grade <grades>` where grades is a comma-separated list
343+
- Format: `--grade <grades>` where grades are a comma-separated list
344344
- Valid grades: A, B, C, D, F (case-insensitive)
345345
- Examples: `--grade b`, `--grade c,d,f`, `--grade D,F`
346346
- When specified, only images with matching grades are displayed in simplified format

plugins/security/commands/set-image-grade-tool-path.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ Next steps:
7575
## Examples
7676

7777
1. **Configure tool path**:
78-
```
78+
```bash
7979
/security:set-image-grade-tool-path ~/Code/container-grade-reporter
8080
```
8181

8282
2. **Configure with absolute path**:
83-
```
83+
```bash
8484
/security:set-image-grade-tool-path /home/user/projects/container-grade-reporter
8585
```
8686

8787
3. **Configure workspace-relative path**:
88-
```
88+
```bash
8989
/security:set-image-grade-tool-path ./container-grade-reporter
9090
```
9191

plugins/security/skills/container-grade-reporter/SKILL.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ This saves the configuration to `~/.config/ai-helpers/security-config.json`:
8585
}
8686
```
8787

88-
**Alternative: Workspace-relative installation**
88+
### Alternative: Workspace-relative installation
8989

9090
If you don't use `/security:set-image-grade-tool-path`, the `/security:image-grades` command will search:
9191
1. `./container-grade-reporter/` (current directory)
@@ -169,7 +169,7 @@ releases:
169169
/security:image-grades ~/my-config.yaml --grade d,f --email
170170
```
171171

172-
**Manual execution using Makefile:**
172+
### Manual execution using Makefile
173173

174174
```bash
175175
cd ~/Code/container-grade-reporter
@@ -306,7 +306,7 @@ print(f"Summary: {len(data)} repositories | Grades: {grade_summary}")
306306

307307
### Common Issues and Solutions
308308

309-
**1. Authentication Failure**
309+
### 1. Authentication Failure
310310

311311
```
312312
Error: Kerberos authentication failed
@@ -319,7 +319,7 @@ Error: Kerberos authentication failed
319319
- Test manual kinit: `kinit -kt ~/keytab.keytab principal@IPA.REDHAT.COM`
320320
- Contact Red Hat IT for keytab issues
321321
322-
**2. Network Connectivity**
322+
### 2. Network Connectivity
323323
324324
```
325325
Error: Cannot connect to pyxis.engineering.redhat.com
@@ -330,7 +330,7 @@ Error: Cannot connect to pyxis.engineering.redhat.com
330330
- Check network access: `curl -k https://pyxis.engineering.redhat.com/v1/`
331331
- Verify no proxy issues blocking API access
332332
333-
**3. Python Version Issues**
333+
### 3. Python Version Issues
334334
335335
```
336336
Error: Python 3.12 not found
@@ -341,7 +341,7 @@ Error: Python 3.12 not found
341341
- Or let Makefile use available Python 3.x (it will fallback automatically)
342342
- Check Python version: `python3 --version`
343343
344-
**4. Missing Dependencies**
344+
### 4. Missing Dependencies
345345
346346
```
347347
Error: ModuleNotFoundError: No module named 'yaml'
@@ -351,7 +351,7 @@ Error: ModuleNotFoundError: No module named 'yaml'
351351
- Let Makefile handle installation: `make install`
352352
- Or manual install: `pip install -r requirements.txt`
353353
354-
**5. Invalid YAML Configuration**
354+
### 5. Invalid YAML Configuration
355355
356356
```
357357
Error: Invalid YAML syntax
@@ -362,7 +362,7 @@ Error: Invalid YAML syntax
362362
- Check indentation (use spaces, not tabs)
363363
- Verify structure matches releases/components format
364364
365-
**6. Repository Not Found**
365+
### 6. Repository Not Found
366366
367367
```
368368
Warning: Repository not found: path/to/repo
@@ -475,9 +475,9 @@ make dry-run-email # Generates HTML without sending
475475

476476
## References
477477

478-
- **Repository**: https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter
479-
- **Pyxis API**: https://pyxis.engineering.redhat.com/v1/
480-
- **Red Hat Registry**: https://registry.access.redhat.com
478+
- **Repository**: [container-grade-reporter](https://gitlab.cee.redhat.com/istio/servicemesh-qe/container-grade-reporter)
479+
- **Pyxis API**: [https://pyxis.engineering.redhat.com/v1/](https://pyxis.engineering.redhat.com/v1/)
480+
- **Red Hat Registry**: [https://registry.access.redhat.com](https://registry.access.redhat.com)
481481
- **Red Hat IT Support**: For keytab and authentication issues
482482

483483
## Notes

0 commit comments

Comments
 (0)