Skip to content

Documentation: update the mailing list address#12

Merged
stefano-garzarella merged 1 commit into
mainfrom
update-ml
May 29, 2025
Merged

Documentation: update the mailing list address#12
stefano-garzarella merged 1 commit into
mainfrom
update-ml

Conversation

@stefano-garzarella

@stefano-garzarella stefano-garzarella commented May 26, 2025

Copy link
Copy Markdown
Owner

We are shutting down the old mailing list, update all references to the mailing list in our documentation.

Summary by Sourcery

Documentation:

  • Replace old svsm-devel mailing list references in index.md, README.md, and CONTRIBUTING.md with the new coconut-svsm@lists.linux.dev address and corresponding archive and subscription URLs

Summary by CodeRabbit

  • Documentation
    • Updated mailing list contact information and archive links in the contributing guidelines, main documentation, and README.
    • Clarified and expanded details on how to join, contact, and manage mailing list subscriptions for the community.

We are shutting down the old mailing list, update all references
to the mailing list in our documentation.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
@sourcery-ai

sourcery-ai Bot commented May 26, 2025

Copy link
Copy Markdown

Reviewer's Guide

Replaces all references to the deprecated project mailing list across documentation with the new email address, archive link, and subscription URL.

File-Level Changes

Change Details Files
Refresh community mailing list section with new address and URLs
  • Replaced old mailing list link with new archive URL
  • Updated contact email to coconut-svsm@lists.linux.dev
  • Added subscription/unsubscription link
Documentation/docs/index.md
README.md
Update mailing list address for patch submissions Documentation/docs/developer/CONTRIBUTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented May 26, 2025

Copy link
Copy Markdown

Walkthrough

The updates revise the project's mailing list contact information across documentation and the README. Old mailing list addresses and URLs are replaced with new ones, including the updated email, archive link, and subscription management URL. No structural or functional changes are made, and no code or public API is affected.

Changes

File(s) Change Summary
Documentation/docs/developer/CONTRIBUTING.md Updated mailing list email address to new contact.
Documentation/docs/index.md, README.md Replaced previous mailing list email and URL with new address, archive link, and subscription URL.

Poem

A hop and a skip, the mailing list’s new,
Fresh links for the bunnies, and humans too!
With lore to explore and subscribe with delight,
Our community’s path is now updated and bright.
So send your patches, don’t be shy,
The coconut-svsm@lists.linux.dev is standing by! 🥥🐇


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sourcery-ai sourcery-ai 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.

Hey @stefano-garzarella - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@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: 0

🧹 Nitpick comments (3)
Documentation/docs/developer/CONTRIBUTING.md (1)

8-8: Consider hyperlinking the mailing list address.

Markdownlint flags bare URLs/emails (MD034). For better readability and consistency, you could format it as [coconut-svsm@lists.linux.dev](mailto:coconut-svsm@lists.linux.dev).

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

8-8: Bare URL used
null

(MD034, no-bare-urls)

README.md (1)

37-39: Linkify bare URLs for readability.

Markdownlint flagged bare URLs here (MD034). Consider formatting these as links, e.g.:

- archive: [lore.kernel.org/coconut-svsm](https://lore.kernel.org/coconut-svsm/)
- subscription/unsubscription: [subspace.kernel.org/lists.linux.dev.html](https://subspace.kernel.org/lists.linux.dev.html)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

37-37: Bare URL used
null

(MD034, no-bare-urls)


38-38: Bare URL used
null

(MD034, no-bare-urls)


39-39: Bare URL used
null

(MD034, no-bare-urls)

Documentation/docs/index.md (1)

26-28: Convert bare URLs to markdown links.

To satisfy markdownlint (MD034) and improve readability, consider turning the raw URLs into Markdown links, for example:

- archive: [lore.kernel.org/coconut-svsm](https://lore.kernel.org/coconut-svsm/)
- subscription/unsubscription: [subspace.kernel.org/lists.linux.dev.html](https://subspace.kernel.org/lists.linux.dev.html)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

26-26: Bare URL used
null

(MD034, no-bare-urls)


27-27: Bare URL used
null

(MD034, no-bare-urls)


28-28: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2ab2d9 and fe2ddfa.

📒 Files selected for processing (3)
  • Documentation/docs/developer/CONTRIBUTING.md (1 hunks)
  • Documentation/docs/index.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
Documentation/docs/developer/CONTRIBUTING.md

8-8: Bare URL used
null

(MD034, no-bare-urls)

README.md

37-37: Bare URL used
null

(MD034, no-bare-urls)


38-38: Bare URL used
null

(MD034, no-bare-urls)


39-39: Bare URL used
null

(MD034, no-bare-urls)

Documentation/docs/index.md

26-26: Bare URL used
null

(MD034, no-bare-urls)


27-27: Bare URL used
null

(MD034, no-bare-urls)


28-28: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Check unsafe blocks
  • GitHub Check: QEMU NOCC boot test
  • GitHub Check: Check
🔇 Additional comments (3)
Documentation/docs/developer/CONTRIBUTING.md (1)

8-8: Confirm updated mailing list address.

The email coconut-svsm@lists.linux.dev correctly replaces the old svsm-devel@coconut-svsm.dev and aligns with other documentation updates.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

8-8: Bare URL used
null

(MD034, no-bare-urls)

README.md (1)

36-39: Update community mailing list details.

The new mailing list address, archive link, and subscription URL are correctly updated to coconut-svsm@lists.linux.dev, https://lore.kernel.org/coconut-svsm/, and https://subspace.kernel.org/lists.linux.dev.html, matching the project's current setup.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

37-37: Bare URL used
null

(MD034, no-bare-urls)


38-38: Bare URL used
null

(MD034, no-bare-urls)


39-39: Bare URL used
null

(MD034, no-bare-urls)

Documentation/docs/index.md (1)

25-29: Consistent community contact info updated.

The documentation now correctly points to the new mailing list (coconut-svsm@lists.linux.dev), the archive, and the subscription management URL, keeping it in sync with README.md and CONTRIBUTING.md.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

26-26: Bare URL used
null

(MD034, no-bare-urls)


27-27: Bare URL used
null

(MD034, no-bare-urls)


28-28: Bare URL used
null

(MD034, no-bare-urls)

@stefano-garzarella stefano-garzarella merged commit f8ef572 into main May 29, 2025
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.

1 participant