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

catalog component readme doesn't include embedded images #4345

Closed
n2ygk opened this issue Feb 1, 2021 · 4 comments
Closed

catalog component readme doesn't include embedded images #4345

n2ygk opened this issue Feb 1, 2021 · 4 comments
Labels
bug Something isn't working

Comments

@n2ygk
Copy link
Contributor

n2ygk commented Feb 1, 2021

This is a pretty minor nit, but the catalog/default/component/component-name pulls in the README.md but not
any referenced images that are pulled in, e.g. via ![alt-text](docs/media/CCbyncsa4.0.png "CC BY-NC-SA 4.0")

Expected Behavior

The "mini" README should render completely

Current Behavior

Image references are rendered as broken images:
image

Possible Solution

Steps to Reproduce

  1. Add this component: https://github.com/columbia-it/django-jsonapi-training/blob/master/catalog-info-github.yaml
  2. Go to http://localhost:3000/catalog/default/component/django-jsonapi-training

Context

Your Environment

  • "@backstage/catalog-client", "version": "0.3.5",
@n2ygk n2ygk added the bug Something isn't working label Feb 1, 2021
@adamdmharvey
Copy link
Member

adamdmharvey commented Feb 1, 2021

@n2ygk Is this a report against RoadieHQ GitHub Insights plugin (https://github.com/RoadieHQ/backstage-plugin-github-insights) by chance? if so, may need to pivot an issue into that repo, as Jira the GitHub Insights plugin isn't a part of the Backstage core (this repo). I may be wrong, but though I'd note it!

@n2ygk
Copy link
Contributor Author

n2ygk commented Feb 1, 2021

@n2ygk Is this a report against RoadieHQ GitHub Insights plugin (https://github.com/RoadieHQ/backstage-plugin-github-insights) by chance? if so, may need to pivot an issue into that repo, as Jira isn't a part of the Backstage core (this repo). I may be wrong, but though I'd note it!

Yes, it could be. Not using Jira anywhere though. It's just pulling in a README from github.

@adamdmharvey
Copy link
Member

Sorry, I wrote JIRA, I meant "github insights" 😁.

@n2ygk
Copy link
Contributor Author

n2ygk commented Feb 1, 2021

Yes, the readme shows up on the Code Insights and and Overview tabs. I'll move this over there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants