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

Add banner to documentation referencing link to latest version #4368

Open
tim-finnigan opened this issue Dec 4, 2024 · 0 comments
Open

Add banner to documentation referencing link to latest version #4368

tim-finnigan opened this issue Dec 4, 2024 · 0 comments
Labels
documentation This is a problem with documentation. feature-request This issue requests a feature. p2 This is a standard priority issue

Comments

@tim-finnigan
Copy link
Contributor

tim-finnigan commented Dec 4, 2024

Describe the feature

Search engines will link outdated and inconsistent versions of boto3 docs. For example:

image

Use Case

Example: #4364.

Proposed Solution

Add a banner at the top linking to the latest. For example: pages that reference a specific past version like https://boto3.amazonaws.com/v1/documentation/api/1.35.6/reference/services/s3/client/delete_objects.html, could have a banner/message referring to https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/delete_objects.html.

Proposed wording for the banner:

Note: This documentation is for a past release of Boto3. To access the latest version of this documentation, please refer to this page. To update your version of Boto3 please follow the instructions here.

@tim-finnigan tim-finnigan added the feature-request This issue requests a feature. label Dec 4, 2024
@tim-finnigan tim-finnigan added documentation This is a problem with documentation. p2 This is a standard priority issue labels Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. feature-request This issue requests a feature. p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

1 participant