Fix documentation typos and formatting by khoveRH · Pull Request #2629 · RamenDR/ramen

khoveRH · 2026-06-24T21:57:45Z

Supersedes #2603 with corrected branch name

Summary by CodeRabbit

Documentation
- Improved wording, capitalization, and formatting across multiple guides (including metrics and quick-start materials).
- Corrected typos and documentation comments in API type definitions (e.g., “initial deployment”, VolSyncSpec naming, and related comment text).
- Updated README link formatting and normalized csi-addons wording in fencing-related guidance.
- Adjusted the S3-compatible endpoint example in the DRCluster CRD documentation.
- Refined Python test environment setup instructions and clarified system test failover/relocate wording.

nirs · 2026-06-24T22:00:49Z

@khoveRH DOC is good now! but you need to rebase this on master and fix the conflicts.

nirs

Need rebase and fixing the conflicts

coderabbitai · 2026-06-24T22:33:29Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4ee028d9-235c-49be-a3c8-41ae520de676

📥 Commits

Reviewing files that changed from the base of the PR and between ce55604 and 137e972.

📒 Files selected for processing (6)

README.md
api/v1alpha1/drplacementcontrol_types.go
api/v1alpha1/volumereplicationgroup_types.go
docs/drcluster-crd.md
docs/metrics.md
docs/user-quick-start.md

✅ Files skipped from review due to trivial changes (6)

api/v1alpha1/drplacementcontrol_types.go
docs/user-quick-start.md
docs/drcluster-crd.md
api/v1alpha1/volumereplicationgroup_types.go
README.md
docs/metrics.md

📝 Walkthrough

Walkthrough

This PR updates API comments and several documentation files, fixing typos, reflowing prose, and changing one example endpoint.

Changes

Documentation and comment updates

Layer / File(s)	Summary
API comment corrections `api/v1alpha1/drplacementcontrol_types.go`, `api/v1alpha1/volumereplicationgroup_types.go`	Corrects the `Deployed` state comment and updates `VolSyncSpec` and `StorageIdentifiers` comment text.
Reference docs wording `README.md`, `docs/drcluster-crd.md`, `docs/metrics.md`	Rewrites the fencing-spec link block, updates the DRCluster S3 endpoint example, and reflows/capitalizes metrics text and headings.
Quick-start wording `docs/user-quick-start.md`	Refines the python environment setup instructions and the manual failover/relocate guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

nirs
parikshithb
raghavendra-talur

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the PR’s main focus on fixing documentation typos and formatting.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

🤖 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/user-quick-start.md`:
- Around line 432-438: Resolve the merge conflict in the failover instructions
by removing the conflict markers and keeping only the intended sentence in the
user quick start guide. Update the affected paragraph in the failover/relocate
section so it reads cleanly using the final wording from the merged text, and
ensure no duplicate phrasing from HEAD remains.

In `@README.md`:
- Around line 48-52: The README still contains unresolved merge-conflict markers
around the fencing specification link, so remove the conflict delimiters and
keep only the single correct link text in the affected README section. Update
the Markdown in the README content to eliminate the duplicated block and leave
just one clean “fencing specification” link entry.

🪄 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 Plus

Run ID: e6e1caac-d557-4546-930b-3be13f72042c

📥 Commits

Reviewing files that changed from the base of the PR and between 813c44e and 9d4a24b.

📒 Files selected for processing (6)

README.md
api/v1alpha1/drplacementcontrol_types.go
api/v1alpha1/volumereplicationgroup_types.go
docs/drcluster-crd.md
docs/metrics.md
docs/user-quick-start.md

📜 Review details

🧰 Additional context used

🪛 markdownlint-cli2 (0.22.1)

docs/user-quick-start.md

[warning] 432-432: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

🔇 Additional comments (5)

api/v1alpha1/drplacementcontrol_types.go (1)

46-46: LGTM!

api/v1alpha1/volumereplicationgroup_types.go (1)

120-120: LGTM!

Also applies to: 296-303

docs/drcluster-crd.md (1)

193-193: LGTM!

docs/metrics.md (1)

8-14: LGTM!

Also applies to: 38-38

docs/user-quick-start.md (1)

43-47: LGTM!

nirs · 2026-06-25T16:57:43Z

+[fencing specification](https://github.com/csi-addons/spec/tree/main/fence)
+=======
+[fencing specification](https://github.com/csi-addons/spec/tree/main/fence)
+>>>>>>> d3de870a (Fix typo in README.md)


The conflict must be fixed in this commit. Every commit must be correct.

usr interactive rebase to fix the conflicts. If you cannot do this reset all commits and recreate them.

Or ask AI agent to fix it.

Signed-off-by: khoveRH <khover@redhat.com>

was invalid endpoint Signed-off-by: khoveRH <khover@redhat.com>

Signed-off-by: khoveRH <khover@redhat.com>

Correct grammatical errors and improve clarity in user guide. Signed-off-by: khoveRH <khover@redhat.com>

Signed-off-by: khoveRH <khover@redhat.com>

nirs · 2026-06-25T18:17:01Z

+
+[fencing specification](https://github.com/csi-addons/spec/tree/main/fence)
+
+


Can you explain this change? The only change needed is replacing csi-addon with csi-addons.

You added one blank line before and 2 after the link. Please avoid unneeded chagnes.

i did not realize anything was added .. I just removed the conflict lines

i think i removed csi-addons accidental

nirs · 2026-06-25T18:18:00Z

-registry in each controller. There are two ways where you can look at the
-metrics in ramen. One way is use prometheus stack(recommended) and the other way
-is to use curl or postman. More details on each of these in the below sections.
+


Why did you add blank line before the paragraph?

I didnt not add intentionally

nirs · 2026-06-25T18:20:13Z

+metrics registry in each controller. There are two ways where you can
+look at the metrics in ramen. One way is use Prometheus stack(recommended)
+and the other way is to use curl or postman. More details on
+each of these in the below sections.


Why did you change formatting? To change prometheus to Prometheus you need one character change in single line. You reformatted the entire paragraph.

How is that happening ? I literally changed p to P

Maybe you editor added unwanted spacing? Maybe this leftover from resolving conflicts?

nirs · 2026-06-25T18:21:31Z

+   The *Ramen* project uses a python tool to create and provision test
+   environment and run tests. This creates a virtual environment including
+   the tools run:
+


The modified text looks good. Remove the added blank line before and after the paragraph.

43 and 44 ? Those were present afaik

nirs · 2026-06-25T18:23:41Z

+
+At this point you can manually failover, relocate one or more
+times as needed.
+


This is not better than the original. When see run manually failover mean the failover script inside basic-test. But this code is not used for long time so there is no point in improving this text. We need to remove basic-test and the related docs.

And again you add blank lines before and after the paragraph.

run run manually failover is better ? I did not add blank lines intentionally

nirs · 2026-06-25T18:48:53Z

Extra whitespace can be fixed by running make fmt - but ti will not fix blank lines added in the middle of a paragraph.

khoveRH requested review from BenamarMk, ShyamsundarR, nirs, parikshithb, raghavendra-talur and rakeshgm as code owners June 24, 2026 21:57

khoveRH mentioned this pull request Jun 24, 2026

Fix documentation typos and clarify examples #2603

Closed

nirs requested changes Jun 24, 2026

View reviewed changes

khoveRH force-pushed the docs-fixes branch from d67fc6a to 9d4a24b Compare June 24, 2026 22:33

coderabbitai Bot reviewed Jun 24, 2026

View reviewed changes

Comment thread docs/user-quick-start.md Outdated

Comment thread README.md Outdated

khoveRH force-pushed the docs-fixes branch from 9d4a24b to ce55604 Compare June 25, 2026 16:46

nirs requested changes Jun 25, 2026

View reviewed changes

khoveRH added 7 commits June 25, 2026 13:31

Fix typo in README.md

6ee9b06

Signed-off-by: khoveRH <khover@redhat.com>

Update S3 compatible endpoint for east region

439bb98

was invalid endpoint Signed-off-by: khoveRH <khover@redhat.com>

Correct capitalization of 'Prometheus' in metrics.md

87f1e92

Signed-off-by: khoveRH <khover@redhat.com>

Fix grammar and clarity in user quick start guide

a33aa77

Correct grammatical errors and improve clarity in user guide. Signed-off-by: khoveRH <khover@redhat.com>

Fix typo in comment for Deployed state

554b20b

Signed-off-by: khoveRH <khover@redhat.com>

Fix typos in comments for StorageID and ReplicationID

3a2d6aa

Signed-off-by: khoveRH <khover@redhat.com>

Fix typo in VolSyncSpec comment

137e972

Signed-off-by: khoveRH <khover@redhat.com>

khoveRH force-pushed the docs-fixes branch from ce55604 to 137e972 Compare June 25, 2026 17:49

nirs requested changes Jun 25, 2026

View reviewed changes


		[fencing specification](https://github.com/csi-addons/spec/tree/main/fence)


		At this point you can manually failover, relocate one or more
		times as needed.

Uh oh!

Conversation

khoveRH commented Jun 24, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

nirs commented Jun 24, 2026

Uh oh!

nirs left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nirs Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nirs commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

khoveRH commented Jun 24, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 24, 2026 •

edited

Loading

nirs Jun 25, 2026 •

edited

Loading

nirs commented Jun 25, 2026 •

edited

Loading