pressbooks/pressbooks

Refinements to new network manager checklist

Closed this issue ยท 9 comments

To fix before release:

  • Resolve caching issues that prevent congrats page from appearing and saved checklist items from being stored/remembered
  • Move the survey out of the congratulations page and make it the last step in the checklist
  • Make sure that link to Network Options page has graceful fallback for open source users (points to https://NETWORK.URL/wp-admin/network/settings.php instead of https://NETWORK.URL/wp-admin/network/settings.php?page=pb_network_analytics_options)
  • Revise Google Analytics step to say 'Learn about Analytics Options' and link them to the revised guide chapter
  • Add OIDC configuration as one of the SSO options (akin to how we currently handle SAML & CAS)
  • Revise network manager guide chapter about Koko Analytics (https://networkmanagerguide.pressbooks.com/chapter/view-page-visit-and-referrer-statistics/ as starting place) to better explain both analytics options Pressbooks supports (Koko & GA) and the pros/cons of each).
  • Add required .env variables to all relevant networks
arzola commented

I sent a friendly commit to solve the cache issue when checklist items are stored

Changes have been pushed to dev and staging networks and should be deployed and ready for testing shortly.

tw77 commented

One thing I'm noticing on Staging when testing as a network manager user:

When I check a box for the first time and quickly navigate away from the Administer Network dashboard (to 'My Books' / the user dashboard), when I return to the Administer Network dashboard, the box is unchecked.

It's only when I check the same box for a second time, navigate away, and navigate back that the box stays as checked from then on.

Update: this was due to navigating away very quickly, but doesn't occur in other situations, see #3384 (comment)

I sent a friendly commit to solve the cache issue when checklist items are stored

If that doesn't work, let's send a hostile commit.

tw77 commented

If you move as quickly as possible to a different page and back after checking a box, the checked state of the box may not have not saved, or the background-color #D4D4D4 for the checked <li> may not have saved. But if you reload or refresh the page, the changes you made will have saved. Encountering this delay in saving only occurs in this unique scenario of moving very quickly away from and back to the checklist, and is solved with page reload. Caching works reliably and as expected, with checklist state being saved for the network as a whole, appearing consistently for multiple super admin / network manager users. Congrats page appears as expected.

tw77 commented

Chapter prepared at this private link. Once approved, its text can be copied and pasted replacing https://networkmanagerguide.pressbooks.com/chapter/view-page-visit-and-referrer-statistics/. Permalink should be kept the same (or if changed, a redirect set up).

Guide chapter looks good to me. Let's ask Amy for review and if good, I think we're ready to deploy!

Env variables will be sent seperately to ops team.

tw77 commented

Revised guide chapter published at https://networkmanagerguide.pressbooks.com/chapter/view-page-visit-and-referrer-statistics/, can be linked from checklist.

Deployed to production networks!