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.

Sign up for GitHub

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

Jump to bottom

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

Closed
wants to merge 4 commits into from
Closed

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

wants to merge 4 commits into from

Conversation

cgruver
Copy link
Collaborator

@cgruver cgruver commented Feb 6, 2025 •
edited by sourcery-ai bot
Loading

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

This PR resolves #743

Summary by Sourcery

Documentation:

  • Remove the reference to the non-existent ramalama.io URL from the contributing documentation.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Feb 6, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request removes a reference to a non-existent documentation page (ramalama.io) in the CONTRIBUTING.md file.

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

File-Level Changes

Change Details Files
Removed reference to non-existent documentation.
  • Removed the link to ramalama.io/getting-started/installation#build-and-run-dependencies.
  • Removed the list of steps that the install documentation would illustrate.
 CONTRIBUTING.md

Assessment against linked issues

Issue Objective Addressed Explanation
#743 Remove the broken link to non-existent documentation in CONTRIBUTING.md ✅
#743 Ensure the CONTRIBUTING.md file provides accurate guidance for setting up dependencies ❌ The PR removes the link and related text without replacing it with alternative installation instructions

Possibly linked issues

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

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 6, 2025
View reviewed changes
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 - here's some feedback:

Overall Comments:

  • The change looks straightforward and appropriate for removing the incorrect docs reference.
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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@rhatdan
Copy link
Member

rhatdan commented Feb 7, 2025

@cgruver could you rebase with the sourcery commit. I tried to do it from the Web site, but the signature is not valid.

@dougsland
Copy link
Collaborator

LGTM

@ericcurtin
Copy link
Collaborator

Commit needs to be signed and repushed:

git commit -a --amend -s

@cgruver
Copy link
Collaborator Author

cgruver commented Feb 7, 2025

Yes, I'll fix it.

cgruver and others added 4 commits February 7, 2025 18:57
@cgruver
Remove reference to non-existent docs in CONTRIBUTING.md
516d572 
Signed-off-by: Charro Gruver <[email protected]>
@rhatdan @sourcery-ai @cgruver
Update CONTRIBUTING.md
3e2b64c 
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Signed-off-by: Charro Gruver <[email protected]>
@bmbouter @cgruver
Update README.md
317f308 
Pulp also has support for this (being a full container registry).

Signed-off-by: Brian Bouterse <[email protected]>
Signed-off-by: Charro Gruver <[email protected]>
@ericcurtin @cgruver
Update progress bar only once every 100ms
97a18c7 
To help with CPU usage

Signed-off-by: Eric Curtin <[email protected]>
Signed-off-by: Charro Gruver <[email protected]>
@cgruver
Copy link
Collaborator Author

cgruver commented Feb 7, 2025

I think I might have broken this by shoving a bunch of other commits into it?

@ericcurtin
Copy link
Collaborator

If I was you I'd merge them all into one signed commit via:

git rebase -i HEAD~1

(you might need to read how to use rebase -i) if you haven't used before.

@cgruver
Copy link
Collaborator Author

cgruver commented Feb 7, 2025

If I was you I'd merge them all into one signed commit via:

git rebase -i HEAD~1

(you might need to read how to use rebase -i) if you haven't used before.

Yeah, to avoid making a bigger mess, I'm going to trash this one and create a clean PR.

@cgruver cgruver closed this Feb 7, 2025
@cgruver cgruver deleted the doc-fix branch February 7, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@rhatdan rhatdan Awaiting requested review from rhatdan rhatdan is a code owner

@ericcurtin ericcurtin Awaiting requested review from ericcurtin ericcurtin is a code owner

@bmahabirbu bmahabirbu Awaiting requested review from bmahabirbu bmahabirbu is a code owner

@maxamillion maxamillion Awaiting requested review from maxamillion maxamillion is a code owner

@swarajpande5 swarajpande5 Awaiting requested review from swarajpande5 swarajpande5 is a code owner

@jhjaggars jhjaggars Awaiting requested review from jhjaggars jhjaggars is a code owner

@slp slp Awaiting requested review from slp slp is a code owner

@engelmi engelmi Awaiting requested review from engelmi engelmi is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md has a bad link for install documentation to see how to install dependencies
5 participants
@cgruver @rhatdan @dougsland @ericcurtin @bmbouter