Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove reference to non-existent docs in CONTRIBUTING.md #761

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

cgruver
Copy link
Collaborator

@cgruver cgruver commented Feb 7, 2025

CONTRIBUTING.md has a reference to ramalama.io which does not exist yet.

This PR #743

Summary by Sourcery

Documentation:

  • Remove the outdated link to the installation documentation from the contributing guide.

Copy link
Contributor

sourcery-ai bot commented Feb 7, 2025

Reviewer's Guide by Sourcery

This PR removes outdated references from CONTRIBUTING.md by deleting the link and related installation instructions to a non-existent documentation site (ramalama.io). The changes focus specifically on cleaning the documentation to prevent confusion for contributors.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Removed outdated documentation references from CONTRIBUTING.md
  • Deleted the link and description pointing to the installation documentation on ramalama.io
  • Removed bullet points that were instructing users to follow steps from the non-existent document
CONTRIBUTING.md

Possibly linked issues

  • #0: The PR removes the bad link mentioned in the issue.

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: 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.

The install documentation will illustrate the following steps:
- Installation of required tools
- Installing RamaLama from source

The minimum version of Python required to use RamaLama is PYTHON 3.12
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (typo): Typo: "PYTHON" should be "Python"

Suggested change
The minimum version of Python required to use RamaLama is PYTHON 3.12
The minimum version of Python required to use RamaLama is Python 3.12

@rhatdan
Copy link
Member

rhatdan commented Feb 7, 2025

LGTM

@rhatdan rhatdan merged commit d659538 into containers:main Feb 7, 2025
16 checks passed
@cgruver cgruver deleted the doc-fix branch February 11, 2025 16:10
@cgruver cgruver restored the doc-fix branch February 11, 2025 16:10
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