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

Update PyPI project links #2510

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Update PyPI project links #2510

merged 1 commit into from
Apr 18, 2024

Conversation

rmartin16
Copy link
Member

@rmartin16 rmartin16 commented Apr 17, 2024

Changes

  • The Documentation link is updated to the default landing page configured in RTD...which is currently stable
    • Previously, this was latest but that seems strange given these links only really show up on PyPI...and the code on PyPI usually isn't the "latest"
  • Add a new "Changelog" link on PyPI for Toga's release history
    • I had previously mentioned linking to the GitHub release page to advertise new releases but it was said that PyPI is the official source of releases
    • That makes sense to me but I've been a little bothered that the release history isn't prominently made available to users on PyPI; this resolves that with a dedicated link
    • The name "Changelog" for the link probably has room for debate...
  • Update RTD link in READMEs to latest instead of stable
    • If you're reading a README, you are probably more interested in the latest documentation than the last release

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@rmartin16
Copy link
Member Author

rmartin16 commented Apr 17, 2024

Example of these changes on PyPI:

https://test.pypi.org/project/x-toga-core-20240417/0.4.3/

Using the name "Changelog" may make this a little too prominent perhaps since PyPI seems to alphabetically sort these links....so, something like "Release History" would move it down...

[EDIT]
These are the expected names for a "changelog" link on PyPI:

["changelog", "change log", "changes", "release notes", "news", "what's new", "history"]

@rmartin16 rmartin16 added the documentation An improvement required in the project's documentation. label Apr 17, 2024
@rmartin16 rmartin16 marked this pull request as ready for review April 17, 2024 16:26
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. I don't think there's any single canonical answer on which version of the docs is best to link. If you're viewing the README on Github, you likely want the latest; but if you're on PyPI, you probably want the stable (and, more specifically, the stable for that release). However, I can't think of an easy way to automate that configuration, and I wouldn't have thought PyPI is a common launching point for README content - or if it is, they're going to use the "Documention" link on the side which will point at stable, so I'm not overly concerned about this.

As for changelog - I don't think it's worth getting bent out of shape over ordering.

@freakboy3742 freakboy3742 merged commit 4617a62 into beeware:main Apr 18, 2024
33 of 34 checks passed
@rmartin16 rmartin16 deleted the pypi-links branch April 18, 2024 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants