docs: sync operator manual with current config#265
Conversation
|
👋 Welcome back, @rvac-bucky! Great to see PR #265 from you. You've contributed 10 merged PRs so far — thank you for your continued support! CI is running now, and a maintainer will review shortly. 🚀 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughSynchronizes docs with current config and workflows: updates operator recipes to use ChangesOperator Manual Alignment
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerBuilt with CodeRabbit's Coding Plans for faster development and fewer bugs. View plan used: ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/wiki/Operator-Manual.md`:
- Line 12: Add the missing blank lines around markdown headings and fenced code
blocks: ensure there is a blank line before each code fence marked with ```yaml
and a blank line after each heading line (lines starting with #); update each
occurrence of the code block fence and heading in the document so that code
blocks are preceded by an empty line and headings are followed by an empty line
to satisfy markdownlint rules.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9a6ffd7b-c887-4a65-afd6-420a648e779b
📒 Files selected for processing (1)
docs/wiki/Operator-Manual.md
| 2. Locate the `filters.exclude_keywords` list. | ||
| 2. Locate the `filtering.exclusion_signals` list. | ||
| 3. Append your new keyword to the bottom of the list in lowercase. | ||
| ```yaml |
There was a problem hiding this comment.
Fix markdown formatting violations.
Markdownlint flags missing blank lines around code blocks and headings at multiple locations. Add blank lines to comply with markdown best practices.
📝 Proposed formatting fixes
Line 12 - Add blank line before code block:
3. Append your new keyword to the bottom of the list in lowercase.
+
```yamlLine 20 - Add blank line after heading:
### 2. Tuning the Thread Pool Size
+
If you are hitting rate limits or GitHub Actions is running out of memory:Line 25 - Add blank line before code block:
3. Lower the source-specific worker count that is causing pressure, then test with the `Update New Grad Jobs` workflow.
+
```yamlLine 41 - Add blank line after heading:
### 3. Adding a New JobSpy Country
+
To add a country-level JobSpy search target:Line 46 - Add blank line before code block:
3. Append a `code` and `location` pair supported by JobSpy/Indeed:
+
```yamlAlso applies to: 20-20, 25-25, 41-41, 46-46
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 12-12: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/wiki/Operator-Manual.md` at line 12, Add the missing blank lines around
markdown headings and fenced code blocks: ensure there is a blank line before
each code fence marked with ```yaml and a blank line after each heading line
(lines starting with #); update each occurrence of the code block fence and
heading in the document so that code blocks are preceded by an empty line and
headings are followed by an empty line to satisfy markdownlint rules.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Operator-Manual.md to align with recent architectural changes, specifically moving configuration settings for keyword filtering and worker pool sizes from hardcoded Python constants to config.yml. It also expands the CI/CD monitoring guide to include new security workflows and provides more detailed troubleshooting steps for merge conflicts and job filtering. Feedback was provided regarding a discrepancy between the newly documented security workflows (OpenSSF Scorecard and SBOM Generator) and the repository's style guide, which currently lacks these entries.
| 3. **Pre-commit (`Code Hygiene (Pre-commit)`)**: | ||
| * **Why it matters**: It automatically catches messy formatting, merge markers, oversized files, private keys, and secret leaks so you don't have to leave nitpicky review comments. If it fails, just ask the contributor to run `pre-commit run --all-files` locally before you merge. | ||
| 4. **Security workflows (`CodeQL Security Scan`, `Vulnerability Scanner (Trivy)`, `OpenSSF Scorecard`, `SBOM Generator`)**: | ||
| * **Why it matters**: These provide code scanning, dependency/container vulnerability checks, supply-chain posture checks, and SBOM output. GitHub will send you an email alert if a critical vulnerability is found. You only need to look at these if you get an alert or one of these required checks blocks a PR. |
There was a problem hiding this comment.
The manual mentions OpenSSF Scorecard and SBOM Generator as part of the security workflows. These are not currently listed in the project's CI Pipeline documentation in the repository style guide (Section 6). If these workflows have been recently added to the repository, please ensure the style guide is also updated to maintain a single source of truth for required CI checks.
References
- The style guide lists Python Lint & Syntax, Pre-commit Hooks, Unit Tests, CodeQL, and Trivy as the required checks in the CI Pipeline. (link)
1 participant
Summary\n- Sync the Operator Manual with current config.yml filtering/API keys\n- Align workflow names and automation behavior with the current GitHub Actions setup\n- Replace stale operational guidance with source-backed scraper/update behavior\n\n## Validation\n- git diff --check\n- .venv/bin/python -m pre_commit run --files docs/wiki/Operator-Manual.md\n- make test (664 passed)\n- Source-backed consistency checks against config.yml, .github/workflows/update-jobs.yml, and scripts/update_jobs.py\n\nCloses #242
Summary by CodeRabbit