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

Discontinue plugin-google-analytics due to the UA sunset #10332

Open
1 of 2 tasks
bohyunjung opened this issue Jul 23, 2024 · 5 comments
Open
1 of 2 tasks

Discontinue plugin-google-analytics due to the UA sunset #10332

bohyunjung opened this issue Jul 23, 2024 · 5 comments
Labels
proposal This issue is a proposal, usually non-trivial change
Milestone

Comments

@bohyunjung
Copy link
Contributor

bohyunjung commented Jul 23, 2024

Have you read the Contributing Guidelines on issues?

Motivation

  • Following the former deprecation, Universal Analytics (UA) has officially sunset as of the week of July 1, 2024.
  • This renders the built-in plugin-google-analytics obsolete, eliminating the need to maintain it in future project releases.
  • Several outbound links within the project are broken due to recent changes in Google Developers documentation.

Task Details

  1. Remove packages/docusaurus-plugin-google-analytics
  2. Remove the dependency from docusaurus-preset-classic
  3. Update the documentation:
    • Remove the plugin documentation
    • Remove all references to the plugin
    • Reorder the Plugins sidebar
  4. Update broken Google links in comments and documentation

Testing

  • Ensure removal of the plugin doesn't break existing functionality
  • Verify all updated links are correct and accessible

Self-service

  • I'd be willing to do some initial work on this proposal myself.
@bohyunjung bohyunjung added proposal This issue is a proposal, usually non-trivial change status: needs triage This issue has not been triaged by maintainers labels Jul 23, 2024
@slorber slorber added this to the 4.0 milestone Jul 23, 2024
@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Jul 23, 2024
@slorber
Copy link
Collaborator

slorber commented Jul 23, 2024

Thanks

Yes we'll remove that plugin but it's technically a breaking change so it will be done for v4.

The plugin is already deprecated in our docs: https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-google-analytics

@bohyunjung
Copy link
Contributor Author

@slorber Thank you for the triage.

It appears that the codebase is not yet accepting PRs for v4. Therefore, I'll leave the plugin itself as-is for now.

In the meantime, I'd like to propose making a PR with the following small changes:

  1. Fix broken outbound links to Google Developers Documentation
  2. Update some expressions in the plugin documentation to reflect that Universal Analytics (UA) is completely obsolete

What are your thoughts on this approach?

@slorber
Copy link
Collaborator

slorber commented Jul 23, 2024

Thanks but I think it's fine in the current state, this warning is big enough

CleanShot 2024-07-23 at 15 04 45

And broken links such as this one do not seem like a big deal either considering it prints "Service Unavailable":
https://developers.google.com/analytics/devguides/collection/analyticsjs/

It's not super useful to improve a page that we plan to remove soon

@bohyunjung
Copy link
Contributor Author

Thanks for the quick feedback. I agree that these changes aren't necessary for the deprecated plugin at this time.

I'd like to note that the active plugin-google-gtag also has a broken link in its documentation:

If it's reasonable to fix this now, I'm happy to do so. Otherwise, I can keep this in mind for the v4 update.

@slorber
Copy link
Collaborator

slorber commented Jul 23, 2024

Thanks, we'd want to fix this one indeed! (for all our docs versions). PR welcome.

It's weird that Google breaks links. They even discontinued their own link shortener recently. 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Development

No branches or pull requests

2 participants