Skip to content

Replace PyPI page with README.md#833

Merged
untitaker merged 4 commits intogetsentry:masterfrom
cclauss:patch-1
Nov 2, 2020
Merged

Replace PyPI page with README.md#833
untitaker merged 4 commits intogetsentry:masterfrom
cclauss:patch-1

Conversation

@cclauss
Copy link
Copy Markdown
Contributor

@cclauss cclauss commented Sep 23, 2020 •
edited
Loading

https://pypi.org/project/sentry-sdk/ is currently a bit too spartan and requires the user to do extra clicks to determine if they want to install or upgrade this package.

This PR proposes to replace the current one-liner with the markdown content from README.md.

@cclauss
Replace pypy page with README.md + CHANGES.md
ad06fe6 
https://pypi.org/project/sentry-sdk/ is currently a bit too spartan and requires the user to do extra clicks to determine if they want to install or upgrade this package.  This PR proposes to replace the current one-liner with the markdown content from `README.md` plus `CHANGES.md`.
@cclauss
fixup! ,
ab23ed0
@cclauss cclauss changed the title Replace pypy page with README.md + CHANGES.md Replace pypy page with README.md Sep 23, 2020
@untitaker
Copy link
Copy Markdown
Member

untitaker commented Sep 24, 2020

Is there a place where we can figure out which constructs are supported in pypi? We have some html in the readme

@cclauss
Copy link
Copy Markdown
Contributor Author

cclauss commented Sep 24, 2020 •
edited
Loading

https://github.com/pypa/warehouse is the place to open/read issues on these topics.

You can always push a trial version to the testpypi server with python3 -m twine upload --repository testpypi dist/*. This will go to a test server instead of the public PyPI so you can see if/how the HTML renders. Also, check the relative links in markdown. These might need to be converted to absolute links to work correctly on PyPI.

My first commit tried to add CHANGES.md to the end but that file is not available.

@untitaker untitaker self-assigned this Nov 2, 2020
@cclauss cclauss changed the title Replace pypy page with README.md Replace PyPI page with README.md Nov 2, 2020
@untitaker untitaker merged commit e6bd271 into getsentry:master Nov 2, 2020
@untitaker
Copy link
Copy Markdown
Member

untitaker commented Nov 2, 2020

Thanks! 👍

@cclauss cclauss deleted the patch-1 branch November 2, 2020 19:14
@cclauss
Copy link
Copy Markdown
Contributor Author

cclauss commented Nov 2, 2020

Which repo contains the Sentry web user interface or is that not open source?

@untitaker
Copy link
Copy Markdown
Member

untitaker commented Nov 2, 2020

That's getsentry/sentry. I think you already contributed to it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@untitaker untitaker

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cclauss @untitaker