Skip to content

doc: add entries to changelog#35

Open
zdover23 wants to merge 1 commit into
cobaltcore-dev:mainfrom
zdover23:docs-2026-06-11-changelog-update
Open

doc: add entries to changelog#35
zdover23 wants to merge 1 commit into
cobaltcore-dev:mainfrom
zdover23:docs-2026-06-11-changelog-update

Conversation

@zdover23

@zdover23 zdover23 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Add commits (and their associated dates) to the changelog that were written by Zac Dover on behalf of Clyso.

Summary by CodeRabbit

  • Documentation
    • Updated the Change Log table to add a new git hash column and populated it for multiple dated documentation/architecture entries, improving traceability.

@zdover23 zdover23 requested a review from senolcolak June 11, 2026 06:50
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated changelog table in docs/changelog/index.md to add a git hash column alongside the existing date and change columns. The table now includes multiple dated documentation and architecture entries with corresponding git hashes, including entries for Ceph, ROOK, Prysm, Arbiter, and Chorus, concluding with a "Change log created" entry tied to a specific git hash.

Changes

Documentation Table Enhancement

Layer / File(s) Summary
Changelog table with git hash column
docs/changelog/index.md
Changelog table restructured from two columns (date, change) to three columns (date, change, git hash), with populated rows tracking multiple architecture and documentation entries and their corresponding commits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog grows with time and care,
Each hash a snapshot, noted there,
From Ceph to Chorus, tracked with pride,
The git commits now side-by-side!
History written, crystal clear—
What changed when, is now quite dear. 🌟

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'doc: add entries to changelog' is vague and generic. While it references the changelog, it doesn't specify what entries are being added or why, using imprecise language that doesn't clearly convey the main purpose of the changeset. Provide a more descriptive title that specifies the key addition, such as 'doc: add git hash column to changelog' or 'docs: populate changelog with git commit hashes'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/changelog/index.md`:
- Line 12: The changelog entry has an incorrect year: the date string
"2025-03-12" in the table row should be "2026-03-12" to keep chronological order
with surrounding entries; update the date literal in the docs/changelog index
table (the row containing "Add Arbiter documentation | 26891975") to
"2026-03-12".
- Around line 17-18: Remove the duplicate changelog entry that appears twice ("|
2026-03-31    | Add CephFS summary to arch    | fd962649  |"); keep a single
instance of that line in docs/changelog/index.md so the changelog is
deduplicated and consistent.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8e92cbad-871f-489a-acfe-0789db5d0b16

📥 Commits

Reviewing files that changed from the base of the PR and between 5e605d9 and f786467.

📒 Files selected for processing (1)
  • docs/changelog/index.md

Comment thread docs/changelog/index.md Outdated
Comment thread docs/changelog/index.md Outdated
@zdover23 zdover23 force-pushed the docs-2026-06-11-changelog-update branch from f786467 to a4a1dc5 Compare June 11, 2026 06:55

@senolcolak senolcolak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes Zac. I think this is more of a commit list than a changelog.

Could we make it a bit more changelog like, we can group related documentation changes and describing the actual purpose/impact? we will have less entries on the list but will be more informative,

the CephFS entry appears twice with the same hash.

The git hashes are useful, but the change descriptions should be a bit more meaningful for reviewers/readers.

@zdover23 zdover23 force-pushed the docs-2026-06-11-changelog-update branch from a4a1dc5 to 3c74663 Compare June 15, 2026 15:09
Add commits (and their associated dates) to the changelog that were
written by Zac Dover on behalf of Clyso.

Signed-off-by: Zac Dover <zac.dover@clyso.com>
@zdover23 zdover23 force-pushed the docs-2026-06-11-changelog-update branch from 3c74663 to fe75144 Compare June 22, 2026 09:21

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/changelog/index.md`:
- Around line 16-18: The changelog file contains a duplicate entry for CephFS
with git hash fd962649 that appears twice with identical content and the same
date of 2026-03-31. Locate both instances of this CephFS changelog entry and
remove one of the duplicates to ensure each changelog entry appears only once in
the file.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9c34ca27-c2e3-46de-8848-175ad053876b

📥 Commits

Reviewing files that changed from the base of the PR and between 3c74663 and fe75144.

📒 Files selected for processing (1)
  • docs/changelog/index.md

Comment thread docs/changelog/index.md
Comment on lines +16 to +18
| 2026-03-31 | Add a summary of RGW to the Architecture page, including an explanation of RGW as a RESTful gateway to store objects and metadata in a Ceph cluster, an explanation of the operation of RGW (as a FastCGI or standalone HTTP service sitting atop the Ceph Storage Cluster), an explanation of RGW's dual API compatibility (with both Amazon S3 and OpenStack Swift), an explanation of the operations supported by the S3-compatible API, an explanation of the operations supported by the Swift-compatible API, an explanation of how RGW can allow multiple independent users to share the same Ceph cluster while maintaining isolation, an explanation of the bucket-based model RGW uses to organize data for S3 compatibility, an explanation of RGW's use of RADOS pools to organize different types of data internally, explanations of advanced features such as object versioning and server-side encryption and cross-origin resource sharing, explanations of RGW's support of horizontal scaling and caching of frequently-accessed objects (to reduce latency), explanations of multi-site replication, asynchronous execution of time-consuming tasks such as garbage collection and data synchronization, explanation of byte-range requests (for large-file retrieval), and explanation of monitoring | 628dfd0c |
| 2026-03-31 | Add a summary of CephFS to the Architecture page, explaining data and metadata management, ceph-mds, POSIX-compliance, methods of accessing CephFS (kernel client, FUSE, libcephfs), snapshots, quotas, support for multiple filesystems, access control (ACLs), and path-based access restrictions | fd962649 |
| 2026-04-28 | Change log created | 953b13ff |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify no duplicate changelog entries exist.
# Check for rows with identical date, description, and git hash.

rg -A1 "Add a summary of CephFS to the Architecture page" docs/changelog/index.md
rg "fd962649" docs/changelog/index.md

Repository: cobaltcore-dev/docs

Length of output: 773


Duplicate CephFS entry still present—removal required.

The CephFS changelog entry (with git hash fd962649) appears twice in the file with identical content. The search results confirm the entry exists at least twice with the same date (2026-03-31) and description. Remove one instance to resolve the duplicate.

🧰 Tools
🪛 LanguageTool

[style] ~17-~17: The words ‘explanation’ and ‘explaining’ are quite similar. Consider replacing ‘explaining’ with a different word.
Context: ...ary of CephFS to the Architecture page, explaining data and metadata management, ceph-mds,...

(VERB_NOUN_SENT_LEVEL_REP)

🤖 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/changelog/index.md` around lines 16 - 18, The changelog file contains a
duplicate entry for CephFS with git hash fd962649 that appears twice with
identical content and the same date of 2026-03-31. Locate both instances of this
CephFS changelog entry and remove one of the duplicates to ensure each changelog
entry appears only once in the file.

@zdover23 zdover23 requested a review from senolcolak June 23, 2026 06:04

@senolcolak senolcolak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks clean and to the point, thanks Zac

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants