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 public documentation links to include the PyPI package in the url #13186

Open
parthea opened this issue Oct 21, 2024 · 1 comment
Open
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Oct 21, 2024

It would be helpful if we include the PyPI package name in the url for the public documentation to make it easier to quickly navigate to the documentation for a specific package.

For example, for google-cloud-backupdr, the documentation exists here instead of here.
https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-backupdr

IOW, we should have google-cloud-backupdr in the url

https://cloud.google.com/python/docs/reference/google-cloud-backupdr/latest/summary_overview

instead of

https://cloud.google.com/python/docs/reference/backupdr/latest/summary_overview

Similarly, for google-cloud-quotas, it should be

https://cloud.google.com/python/docs/reference/google-cloud-quotas/latest/summary_overview

instead of

https://cloud.google.com/python/docs/reference/google-cloud-cloudquotas/latest/summary_overview

As part of this bug, we should audit all packages, and make sure it is easy to navigate to the docs by url with only the package name.

@parthea
Copy link
Contributor Author

parthea commented Oct 21, 2024

As part of the solution, we should ensure that both the old and the new urls work so that there are no broken links.
eg.
Both https://cloud.google.com/python/docs/reference/google-cloud-quotas/latest/summary_overview and https://cloud.google.com/python/docs/reference/google-cloud-cloudquotas/latest/summary_overview work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant