Wordpress README Update#18
Conversation
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
WordPress Template AdditionFiles added:
Template schema (
Security configuration (
README documentation:
Repository documentation impact:
Pre-commit/tooling:
WalkthroughDocumentation update to the WordPress template README, adding a disclaimer that the REST API is disabled by default and providing instructions for enabling it by modifying the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@templates/wordpress/README.md`:
- Line 26: Add a single blank line before the "## Files" heading to satisfy
Markdown formatting (MD022); locate the heading "## Files" in
templates/wordpress/README.md and insert one empty line immediately above it so
the heading is separated from the previous content.
- Line 39: The README heading "## Customization Tips" uses American spelling;
update that heading text (the line containing "## Customization Tips") to
British English by changing "Customization" to "Customisation" so it reads "##
Customisation Tips" to comply with the documentation style guide.
- Around line 5-20: Fix the README markdown by adding blank lines around the
fenced code blocks and a language specifier, and ensure a blank line precedes
the next heading: in the "⚠️ Disclaimer – REST API Not Working in Standard
Config" section update both code fences showing ALLOWED_METHODS to use ```text
(not ```), add an empty line before each opening ```text and after each closing
```text, and insert a blank line before the "## Prerequisites" heading so the
heading is separated from the preceding paragraph/block.
- Line 30: Add a single blank line above the "## Setup" heading in README.md so
the heading "## Setup" is separated by an empty line from the previous content
(fixes MD022); locate the "## Setup" heading and insert one blank line
immediately before it.
🪄 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: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: daf1c3d1-244c-4535-bb0d-98c7eea7086f
📒 Files selected for processing (1)
templates/wordpress/README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
templates/**/README.md
⚙️ CodeRabbit configuration file
templates/**/README.md: Per-template README files exist to help users import and tune the template:
- State the target upstream service and minimum version validated (for example "Nextcloud 29+"), and call out any prerequisites on the upstream side (trusted proxies, headers, database).
- Document the distribution mode the template is aimed at (UI Raw import — recommended — and/or plugin bundle), mirroring the language in
TEMPLATE_GUIDE.md.- Explain non-obvious BunkerWeb settings defined in
template.json, especially any that relax defaults, and say why.- Provide the validation commands the author actually ran. The canonical NGINX snippet check is
nginx -t -c <(printf 'events{} http{ include templates/<name>/configs/<file>.conf; }'); also suggestjq . templates/<name>/template.jsonfor JSON sanity, anddocker compose configorkubectl apply --server-dry-run -fonly when the README genuinely walks the user through those integrations.- Use British English, wrap commands in backticks, and keep lines to roughly 100 characters.
- Never include real credentials, real domains, or copy-pasted upstream licence text.
Files:
templates/wordpress/README.md
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation should be concise, accurate, and written in British English:
- Keep a sensible heading hierarchy and prefer concrete instructions over narrative.
- Commands go in backticks or fenced code blocks; keep lines under roughly 100 characters.
- Check that referenced paths, settings, workflows, and external links still match the current repository.
- When a PR changes behaviour, defaults, or packaging, require the matching doc update in the same PR.
Files:
templates/wordpress/README.md
🪛 LanguageTool
templates/wordpress/README.md
[uncategorized] ~34-~34: The official name of this content management system is spelled with a capital “P”.
Context: .... - Plugin bundle: copy the entire wordpress/ directory into your plugin's `templat...
(WORDPRESS)
🪛 markdownlint-cli2 (0.22.0)
templates/wordpress/README.md
[warning] 12-12: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 12-12: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 17-17: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 30-30: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
| ## ⚠️ Disclaimer – REST API Not Working in Standard Config | ||
|
|
||
| The REST API is **disabled by default** to avoid opening an unnecessary attack vector. Most WordPress installations do not require it, so this is intentional. | ||
|
|
||
| To enable the REST API, add `PUT` and `DELETE` to the `ALLOWED_METHODS` field in your configuration: | ||
|
|
||
| **Default (REST API disabled):** | ||
| ``` | ||
| "ALLOWED_METHODS": "GET|POST|HEAD|OPTIONS" | ||
| ``` | ||
|
|
||
| **Updated (REST API enabled):** | ||
| ``` | ||
| "ALLOWED_METHODS": "GET|POST|HEAD|OPTIONS|PUT|DELETE" | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Fix markdown formatting in the disclaimer section.
The disclaimer content is accurate and follows the coding guidelines' requirement to document the REST API as disabled by default with explicit default vs. updated examples. However, the markdown formatting needs correction:
- Fenced code blocks should have a language specifier: Add
textafter the opening triple backticks (lines 12, 17). - Fenced code blocks should be surrounded by blank lines: Add blank lines before line 12 and after lines 14 and 19.
- Heading should be surrounded by blank lines: Add a blank line before line 21 (Prerequisites heading).
As per coding guidelines, commands and configuration examples should be properly formatted in fenced code blocks.
📝 Proposed fix for markdown formatting
To enable the REST API, add `PUT` and `DELETE` to the `ALLOWED_METHODS` field in your configuration:
**Default (REST API disabled):**
+
-```
+```text
"ALLOWED_METHODS": "GET|POST|HEAD|OPTIONS"Updated (REST API enabled):
+
- +text
"ALLOWED_METHODS": "GET|POST|HEAD|OPTIONS|PUT|DELETE"
+
## Prerequisites
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 12-12: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 12-12: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 17-17: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@templates/wordpress/README.md` around lines 5 - 20, Fix the README markdown
by adding blank lines around the fenced code blocks and a language specifier,
and ensure a blank line precedes the next heading: in the "⚠️ Disclaimer – REST
API Not Working in Standard Config" section update both code fences showing
ALLOWED_METHODS to use ```text (not ```), add an empty line before each opening
```text and after each closing ```text, and insert a blank line before the "##
Prerequisites" heading so the heading is separated from the preceding
paragraph/block.
| - The BunkerWeb UI or the ability to edit multisite settings directly. | ||
| - Domain name(s) that will serve the WordPress instance. | ||
|
|
||
| ## Files |
There was a problem hiding this comment.
Add blank line before heading.
The "Files" heading should have a blank line above it per markdown formatting conventions (MD022).
📝 Proposed fix
- Domain name(s) that will serve the WordPress instance.
+
## Files🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@templates/wordpress/README.md` at line 26, Add a single blank line before the
"## Files" heading to satisfy Markdown formatting (MD022); locate the heading
"## Files" in templates/wordpress/README.md and insert one empty line
immediately above it so the heading is separated from the previous content.
| - `template.json` – BunkerWeb template definition containing default settings, configs, and guided steps. | ||
| - `configs/modsec/wordpress_false_positives.conf` – ModSecurity CRS tuning for WordPress admin, cron, and XML-RPC traffic. | ||
|
|
||
| ## Setup |
There was a problem hiding this comment.
Add blank line before heading.
The "Setup" heading should have a blank line above it per markdown formatting conventions (MD022).
📝 Proposed fix
- `configs/modsec/wordpress_false_positives.conf` – ModSecurity CRS tuning for WordPress admin, cron, and XML-RPC traffic.
+
## Setup📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Setup | |
| - `configs/modsec/wordpress_false_positives.conf` – ModSecurity CRS tuning for WordPress admin, cron, and XML-RPC traffic. | |
| ## Setup |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 30-30: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@templates/wordpress/README.md` at line 30, Add a single blank line above the
"## Setup" heading in README.md so the heading "## Setup" is separated by an
empty line from the previous content (fixes MD022); locate the "## Setup"
heading and insert one blank line immediately before it.
| 3. **Customize the settings** highlighted in the template steps (domains, upstream host, TLS options). | ||
| 4. **Reload the service** and verify WordPress loads through BunkerWeb. | ||
|
|
||
| ## Customization Tips |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Consider using British English spelling.
The heading uses "Customization" (American spelling) rather than "Customisation" (British spelling). As per coding guidelines, documentation should be written in British English.
This is a pre-existing inconsistency rather than something introduced in this PR, but it would be good to align with the coding standards.
🇬🇧 Proposed fix
-## Customization Tips
+## Customisation Tips📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Customization Tips | |
| ## Customisation Tips |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 39-39: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@templates/wordpress/README.md` at line 39, The README heading "##
Customization Tips" uses American spelling; update that heading text (the line
containing "## Customization Tips") to British English by changing
"Customization" to "Customisation" so it reads "## Customisation Tips" to comply
with the documentation style guide.
3 participants
Summary
Testing
jq . templates/<template-name>/template.jsonValidation details
Checklist
pre-commit run --all-files.template.jsonreferences only files shipped in the same template directory.