Skip to content

docs: remove twitter in favor of bluesky and mastodon#3217

Merged
johanneskoester merged 2 commits intomainfrom
docs/bluesky-mastodon
Nov 21, 2024
Merged

docs: remove twitter in favor of bluesky and mastodon#3217
johanneskoester merged 2 commits intomainfrom
docs/bluesky-mastodon

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Nov 21, 2024

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

  • New Features
    • Updated social media links in the documentation.
    • Added Bluesky and Mastodon badges for following Johannes Köster.
    • Removed the Twitter badge.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Nov 21, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve updates to the docs/index.rst file, specifically modifying social media badges. The Twitter badge has been removed, while new badges for Bluesky and Mastodon have been added, linking to Johannes Köster's profiles on these platforms. The overall structure and content of the document remain unchanged.

Changes

File Change Summary
docs/index.rst Removed Twitter badge; added Bluesky badge linking to Johannes Köster's profile; added Mastodon badge linking to his Fosstodon profile.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    User->>Docs: Access documentation
    Docs->>User: Display updated social media links
    User->>Docs: Click on Bluesky badge
    Docs->>User: Redirect to Bluesky profile
    User->>Docs: Click on Mastodon badge
    Docs->>User: Redirect to Fosstodon profile
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
docs/index.rst (2)

Line range hint 1-300: Update remaining Twitter reference in the Getting started section

There's still a Twitter reference in the documentation that needs to be updated to reflect the move to Bluesky and Mastodon:

-* News about Snakemake are published via `Twitter <https://twitter.com/search?l=&q=%23snakemake%20from%3Ajohanneskoester>`_.
+* News about Snakemake are published via `Bluesky <https://bsky.app/profile/johanneskoester.bsky.social>`_ and `Mastodon <https://fosstodon.org/@johanneskoester>`_.

Twitter references found in multiple documentation files

The codebase contains Twitter-related references in the following locations:

  • docs/index.rst: Twitter news announcement link
  • apidocs/index.rst: Twitter follow badge and link
  • README.md: Twitter follow badge and link

All these references point to the same Twitter URL pattern (twitter.com/search?l=&q=%23snakemake%20from%3Ajohanneskoester) and should be updated or removed to align with the migration away from Twitter.

🔗 Analysis chain

Line range hint 1-300: Verify for additional Twitter references in the codebase

Let's ensure we haven't missed any other Twitter references that need updating.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Twitter-related terms in the codebase
echo "Searching for Twitter references..."
rg -i "twitter|tweet" --type rst --type md --type txt

Length of output: 685

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 76d5329 and dc9dd39.

📒 Files selected for processing (1)
  • docs/index.rst (1 hunks)
🔇 Additional comments (1)
docs/index.rst (1)

32-38: LGTM! Badge additions are well-formatted and consistent.

The new Bluesky and Mastodon badges follow the established pattern and maintain visual consistency with the existing badges.

@sonarqubecloud
Copy link
Copy Markdown

@johanneskoester johanneskoester merged commit 231c6df into main Nov 21, 2024
@johanneskoester johanneskoester deleted the docs/bluesky-mastodon branch November 21, 2024 10:37
johanneskoester pushed a commit that referenced this pull request Nov 27, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.25.4](v8.25.3...v8.25.4)
(2024-11-27)


### Bug Fixes

* clean env vars in apptainer
([#3199](#3199))
([76d5329](76d5329))
* ensure that intermediate files in job groups do not cause spurious
mtime errors when checking for consistency with output files
([#3220](#3220))
([4ba2bdf](4ba2bdf))
* Remove incomplete marker also when drop-metadata is active
([#3215](#3215))
([a4f2e5c](a4f2e5c))
* Remove incomplete marker for job finished only after metadata is
written ([#3197](#3197))
([6567e5f](6567e5f))
* Support versioned URLs in Asset class and fix missing versions in
Snakemake report
([#3203](#3203))
([f086f6c](f086f6c))
* update rust-script usage to recent version (v0.35.0)
[#3183](#3183)
([#3208](#3208))
([43885d7](43885d7))


### Documentation

* clarify continuously updated input section
([#3219](#3219))
([72a6994](72a6994))
* Fix typo in CHANGELOG.md
([#3198](#3198))
([0e445ed](0e445ed))
* refer to Merkle trees instead of "blockchain" in caching.rst
([#3216](#3216))
([282e5d9](282e5d9))
* remove twitter in favor of bluesky and mastodon
([#3217](#3217))
([231c6df](231c6df))
* use "dictionary" not "array" wording in config docs
([#3156](#3156))
([17aed41](17aed41))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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