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

[docs] Fix missing images on PyPI page #19028

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

smackesey
Copy link
Collaborator

@smackesey smackesey commented Jan 4, 2024

Summary & Motivation

Currently there are several images missing on our PyPI page:

image

The PyPI page is derived from the Dagster README, which gets copied into the long_description field of the PyPI package. img elements in the README with relative URLs then can't be resolved.

This PR replaces the all relative URLs in img tags with full URLs to github master.

How I Tested These Changes

Not sure how to directly test PyPI without releasing, but:

@smackesey
Copy link
Collaborator Author

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@smackesey smackesey marked this pull request as ready for review January 4, 2024 20:41
@smackesey smackesey merged commit c753a24 into master Jan 4, 2024
1 check passed
@smackesey smackesey deleted the sean/fix-readme-missing-images branch January 4, 2024 20:49
danielgafni pushed a commit to danielgafni/dagster that referenced this pull request Jan 6, 2024
## Summary & Motivation

Currently there are several images missing on our PyPI page:


![image](https://github.com/dagster-io/dagster/assets/1531373/183a6af0-30a7-4b7e-a22f-aae8a7bf195d)

The PyPI page is derived from the Dagster README, which gets copied into
the `long_description` field of the PyPI package. `img` elements in the
README with relative URLs then can't be resolved.

This PR replaces the all relative URLs in `img` tags with full URLs to
github master.

## How I Tested These Changes

Not sure how to directly test PyPI without releasing, but:

- You can see the README still renders on this branch.
- These people had the same problem/solution:
reflex-dev/reflex#1558
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