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: Add support for Adobe Analytics in documentation #3322

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

rlhagerm
Copy link

This PR adds the aws s_code script to the element of the page template, in order to support Adobe Analytics within the BotoCore generated documentation pages.

Background

The DX Code examples team is working with AWS Marketing and Metrics Engineering to ensure Adobe Analytics capabilities for all AWS SDK API references. This will support our goals in 2025 to track user usage of pages, and particularly code examples throughout the AWS SDK documentation.

This PR includes the change discussed with @jonathan343 as part of this metrics initiative.

@jonathan343
Copy link
Contributor

Copying context from a discussion with @rlhagerm:

  • We've both been able to generate the botocore docs locally and verified that the following script is being properly added to the <head> section of the generated html pages.
<script src="https://a0.awsstatic.com/s_code/js/3.0/awshome_s_code.js"></script>
  • There is a bug when the "Cookie Preferences" menu is opened/closed. The scrolling for botocore docs gets disabled and prevents the user from navigating anywhere on the page. This seems to be related to the 3 year old version of shortbreadv1.js.

Next Steps:

  • Determine where shortbread should be sourced from and if updating resolves the bug mentioned above.

@rlhagerm rlhagerm marked this pull request as draft December 19, 2024 20:34
@rlhagerm
Copy link
Author

Converting this PR to draft because it is dependent on the BotoCore version of this PR being merged first boto/boto3#4369

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