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.

Sign up for GitHub

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

Jump to bottom

Add segment analytics #74

Merged
merged 3 commits into from
Oct 6, 2022
Merged

Add segment analytics #74

merged 3 commits into from
Oct 6, 2022

Conversation

javabster
Copy link
Collaborator

@javabster javabster commented Sep 14, 2022 •
edited
Loading

Included in this PR:

  • Added segment analytics to monitor page views
  • Added analytics to page feedback buttons (is this helpful? yes/no)
  • Made analytics script configurable so users can opt in to have page views/clicks tracked. Analytics script only run if users set analytics_enabled: True in their conf.py

@javabster javabster marked this pull request as draft September 14, 2022 19:17
@javabster
Copy link
Collaborator Author

screenshots, Thankyou message appears after clicking one of the buttons

Screenshot 2022-09-15 at 10 18 24 AM

@javabster
Copy link
Collaborator Author

The analytics script is the same as was used in the original Qiskit Textbook implementation. This is difficult to test out locally, but checking the logs (and with much support from @vabarbosa ❤️ ) we can at least check in the logs that bluemix analytics is being pinged for page views and CTA tracking

@javabster javabster marked this pull request as ready for review September 15, 2022 14:25
@HuangJunye HuangJunye self-assigned this Sep 27, 2022
@agebbie
Copy link
Collaborator

agebbie commented Oct 6, 2022

Synced with Va on this, and I think this all looks good! Starting with page views and CTA clicked for Yes/ No button works. Just to confirm for the button, would "Yes" or "No" be stored in the CTA property? As long as that is captured through one of the properties I think this all sounds perfect!

@javabster
Copy link
Collaborator Author

Just to confirm for the button, would "Yes" or "No" be stored in the CTA property? As long as that is captured through one of the properties I think this all sounds perfect!

@agebbie Yep! If it works how I think it does the CTA property should say either Helpful - yes or Helpful - no depending on which button is clicked

@javabster javabster merged commit f002eea into Qiskit:layout_refactor Oct 6, 2022
@HuangJunye HuangJunye mentioned this pull request Oct 18, 2022
Closed
HuangJunye added a commit that referenced this pull request Nov 18, 2022
@javabster @abdonrd
@HuangJunye @1ucian0
Layout refactor: Add unified top menu and segment analytics (#119)
6538ba1 
* Add segment analytics (#74)

* resolved merge conflicts

* Made helpful buttons configurable

* Added segment analytics and restyled thankyou msg

* Tidy up `layout.html` (#68)

* Started refactoring layout.html

* Tidy up footer section

* tidied up layout

* removed extra copyright logic

* remove unused javascript

* undo link changes

* remove test copy

* Updated jonja vars

* Replace top-menu with qiskit-ui-shell (#116)

* Replace top-menu with qiskit-ui-shell

# Conflicts:
#	qiskit_sphinx_theme/layout.html

* Update ui-shell file

* Replace import from a CDN

* Replace preload with modulepreload

* Update @qiskit/web-components

* Fixed mobile menu dropdown

Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
Co-authored-by: Abby Mitchell <abby.s.mitchell@gmail.com>

* Final updates for layout refactor feature (#120)

* Removed repo_name var

* Uodated readme, adjusted sidebar

* some minor changes to tidy up files (#121)

* Removed repo_name var

* Uodated readme, adjusted sidebar

* Tidy up some files

* Remove unnecessary jinja variables (#122)

* Update README.md

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Update qiskit_sphinx_theme/footer.html

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Update docs/conf.py

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Removed unnecessary jquery

* Update qiskit_sphinx_theme/footer.html

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Update qiskit_sphinx_theme/breadcrumbs.html

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Co-authored-by: Abdón Rodríguez Davila <a@abdonrd.com>
Co-authored-by: Junye Huang <h.jun.ye@gmail.com>
Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
HuangJunye added a commit that referenced this pull request Feb 21, 2023
@javabster @HuangJunye
New sidebar structure (#138)
fb2f874 
* First experiments with sidebar refactor

* Add segment analytics (#74)

* resolved merge conflicts

* Made helpful buttons configurable

* Added segment analytics and restyled thankyou msg

* Started refeactring sidebar

* Made more configurable

* Some changes to sidebar and styles

* Fixed sidebar dropdown issues

* Fixed language dropdown and styling

* Updated README and fixed style bug

* Tidied up files

* Tidied up code

* Fixed some small merge issues and styles

* Resolved merge conflicts

* Updated README

* Added dummy language extension

* Attempted to fix parallel warning

* Tidied up code

* Refactor sidebar logic

* Fix toctree lint

* lint

* fix toctree

* Apply suggestions from code review

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Updated README

---------

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agebbie agebbie agebbie approved these changes

Assignees

@HuangJunye HuangJunye

Labels
None yet
Projects
No open projects
Qiskit Sphinx Theme
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@javabster @agebbie @HuangJunye