docs: additions to systemd installation doc#373
Conversation
📝 WalkthroughWalkthroughThe systemd installation docs were revised: added a Limitations section, switched Patroni installation from pip to the Changes
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
Up to standards ✅🟢 Issues
|
fe82d0d to
d92f21a
Compare
mmols
left a comment
There was a problem hiding this comment.
Doc updates look good, pending QA running through them more in depth. I suggested one change to the preview note at the top of the doc.
d92f21a to
f38cbb7
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/installation/systemd.md`:
- Around line 46-47: The two bullet descriptions for Etcd ports are reversed:
change the entry that currently states "Port 2379 uses TCP for Etcd peer
communication" to say "Port 2379 uses TCP for Etcd client communication" and
change the entry that currently states "Port 2380 uses TCP for Etcd client
communication" to say "Port 2380 uses TCP for Etcd peer communication" so that
port 2379 is documented as client and port 2380 as peer; update any adjacent
wording referencing these ports to match the corrected roles.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b221be61-4a88-43f3-9714-92bcb99c97f2
📒 Files selected for processing (1)
docs/installation/systemd.md
Adds sections to describe the limitations in the current release and how to uninstall the control plane. Also cleans up some of the formatting to comply with our documentation standards. PLAT-560
f38cbb7 to
007b891
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/installation/systemd.md (1)
62-62: ⚡ Quick winAddress markdownlint findings to meet the stated docs-formatting objective.
These changed lines still trigger markdownlint warnings (
MD046andMD028). Since this PR explicitly targets documentation standards cleanup, it’s worth resolving them in this pass.Also applies to: 145-145, 151-151, 157-157, 198-198, 233-233, 246-246, 270-270, 276-276, 285-285, 291-291, 301-301, 317-317, 324-324, 336-336
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/installation/systemd.md` at line 62, Fix markdownlint MD046/MD028 by ensuring all fenced code blocks use a consistent fence style and have a blank line separating them from preceding list items or paragraphs: replace any inconsistent fences with triple backticks (```) and ensure the opening and closing fences match and include the language tag (e.g., ```sh) consistently; also add a single blank line before each fenced block when it follows a list item or paragraph to satisfy MD028. Apply these changes to the occurrences mentioned (the triple-backtick/code-block markers such as ```sh at the noted locations).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/installation/systemd.md`:
- Around line 331-333: The docs currently imply the instance data path comes
from the control-plane config, but for systemd-managed PostgreSQL the path is
package-manager / service-derived (e.g.,
/var/lib/pgsql/<major_version>/<instance_id>); update the wording around
`/var/lib/pgsql/<major_version>/<instance_id>` to state the default is set by
the package/systemd unit and not the control-plane config, and instruct
operators to confirm the actual data directory by inspecting the PostgreSQL
systemd service/unit (or package documentation) or by checking the
PGDATA/data_directory setting in postgresql.conf before removing any files so
custom locations aren’t accidentally deleted.
---
Nitpick comments:
In `@docs/installation/systemd.md`:
- Line 62: Fix markdownlint MD046/MD028 by ensuring all fenced code blocks use a
consistent fence style and have a blank line separating them from preceding list
items or paragraphs: replace any inconsistent fences with triple backticks (```)
and ensure the opening and closing fences match and include the language tag
(e.g., ```sh) consistently; also add a single blank line before each fenced
block when it follows a list item or paragraph to satisfy MD028. Apply these
changes to the occurrences mentioned (the triple-backtick/code-block markers
such as ```sh at the noted locations).
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3d0d0a95-40d2-467c-b452-f340ba1db6e2
📒 Files selected for processing (1)
docs/installation/systemd.md
Summary
Adds sections to describe the limitations in the current release and how to uninstall the control plane. Also cleans up some of the formatting to comply with our documentation standards.
Testing
Notes for Reviewers
The change to pgEdge Enterprise Postgres Patroni requires a small code change that I've made in #372.
PLAT-560