Skip to content

docs: fix image link in README.md #2915

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

Closed
terriko opened this issue Apr 18, 2023 · 1 comment · Fixed by #2940
Closed

docs: fix image link in README.md #2915

terriko opened this issue Apr 18, 2023 · 1 comment · Fixed by #2940
Assignees
Labels
documentation Documentation changes hackathon Issues for folk participating in the Open Ecosystems hackathon

Comments

@terriko
Copy link
Contributor

terriko commented Apr 18, 2023

I recently added an image to README.md using a relative link here:

https://github.com/intel/cve-bin-tool/blob/main/README.md?plain=1#L24

It works fine when you view https://github.com/intel/cve-bin-tool/ and get the preview, but we use the README.md file in a few other places including pypi and as part of what we build for Read the Docs, so it would probably be better to use a full url for that image instead.

Probably the right url to use is this "raw" view from github:

https://raw.githubusercontent.com/intel/cve-bin-tool/main/doc/images/cve-bin-tool-workflow-800px.png

This should be a one-line fix and suitable for a new contributor. Please leave this issue for a new contributor taking part in the Open Source Hackathon April 2023.

Short tips for new contributors:

  • cve-bin-tool's contributor docs
  • If you've contributed to open source but not this project, you might just want our checklist for a great pull request
  • cve-bin-tool uses https://www.conventionalcommits.org/ style for commit messages, and we have a test that checks the title of your pull request (PR). A good potential title for this one is in the title of this issue.
  • You can make an issue auto close by including a comment "fixes #ISSUENUMBER" in your PR comments where ISSUENUMBER is the actual number of the issue. This "links" the issue to the pull request.

Claiming issues:

  • You do not need to have an issue assigned to you before you work on it. To "claim" an issue either make a linked pull request or comment on the issue saying you'll be working on it.
  • If someone else has already commented or opened a pull request, assume it is claimed and find another issue to work on.
  • If it's been more than 1 week without progress, you can ask in a comment if the claimant is still working on it before claiming it yourself (give them at least 3 days to respond before assuming they have moved on).
@terriko terriko added documentation Documentation changes hackathon Issues for folk participating in the Open Ecosystems hackathon labels Apr 18, 2023
@stvml
Copy link
Contributor

stvml commented Apr 25, 2023

Hackathon Team 1 would like to work on this issue!

terriko pushed a commit that referenced this issue Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes hackathon Issues for folk participating in the Open Ecosystems hackathon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants