Skip to content

Add heap.io info to docs site headers #241

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

Merged

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 5, 2024

Internal Notes for Reviewers

This PR adds heap.io code to track how our docs are performing:

  • _quarto.yml — new include-in-header parameter that references heap-production.html
  • heap-production.html — the script include from heap.io for the production project
  • Makefile — now prevents deploying the docs-demo site unless you are on the docs-demo branch with its own development project tracking

In the HTML output, these changes show up inside of <head> as expected:

image

More background info in sc-5291.

External Release Notes

@nrichers nrichers added the internal Not to be externalized in the release notes label Jul 5, 2024
@nrichers nrichers requested review from validbeck and noosheenv July 5, 2024 00:48
@validbeck
Copy link
Collaborator

@nrichers Can I get access to heap.io so I can see some data? 😅

@nrichers
Copy link
Collaborator Author

nrichers commented Jul 5, 2024

@nrichers Can I get access to heap.io so I can see some data? 😅

Right — that sort of would be required to make sense of this PR, wouldn't it? Invited you just now, check your email.

@nrichers
Copy link
Collaborator Author

nrichers commented Jul 5, 2024

@gtagle since you mentioned you're looking at Heap again — FYI, this PR will use the same project as our production Platform UI, based on convos I had with Mehdi & Andres, and what I found in the Heap documentation.

Nothing you need to do, mainly just an FYI.

@nrichers nrichers changed the title Add heap.io info to headers Add heap.io info to docs site headers Jul 5, 2024
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

I see the changes in _quarto.yml & heap.html, and see the script in the <head> on:

  • Regular articles
  • .ipynb
  • Test descriptions

🎉

@nrichers
Copy link
Collaborator Author

nrichers commented Jul 8, 2024

@validbeck @noosheenv I've added some restrictions to our Makefile for deploying the docs-demo site: you now need to be on the docs-demo branch to deploy.

As discussed, the reason for this change is to avoid sending tracking info into our production project on heap.io that isn't actually production data (e.g., a PR in progress).

The docs-demo site uses the development project for its own tracking.

@nrichers nrichers merged commit 359c92e into main Jul 8, 2024
6 checks passed
@nrichers nrichers deleted the nrichers/sc-5291/add-tracking-via-heap-to-our-docs-site branch July 8, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants