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

Remove "was this page useful" mechanism (analytics) #579

Merged
merged 4 commits into from
Dec 1, 2023

Conversation

Eric-Arellano
Copy link
Collaborator

Qiskit documentation now lives in docs.quantum.ibm.com and has its own analytics mechanism.

The Qiskit Ecosystem projects will be migrating to GitHub pages. Qiskit/ecosystem#578. Given that, I doubt we'll want to commit to still maintaining this analytics mechanism. Maintenance is more than only the code: it also means committing to helping projects access the dashboard.

Instead, keep this Sphinx theme as simple as possible to make it more sustainable. Projects highly interested in analytics could always add the functionality their own way.

Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

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

Nice!

I found the following remaining references to the analytics:

CONTRIBUTING.md
97:1. Find the "actual" snapshot for the failing test, such as `footer-includes-page-analytics-1-actual.png`.

src/qiskit_sphinx_theme/assets/styles/_footer.scss
14:.qiskit-analytics-container {
40:#qiskit-analytics-thank-you {

src/qiskit_sphinx_theme/ecosystem/page.html
108:        {% include "custom_templates/footer_analytics.html" %}

tests/js/ecosystem.test.js
114:    const yesOption = page.locator("div.qiskit-analytics-container a").first();

Should these be removed too?

@Eric-Arellano
Copy link
Collaborator Author

Yes. Good catch @frankharkins / pardon my oversight

Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@Eric-Arellano Eric-Arellano merged commit 11eb12c into Qiskit:main Dec 1, 2023
5 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/rm-analytics branch December 1, 2023 16:43
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