facebook / docusaurus

Easy to maintain open source documentation websites.
https://docusaurus.io
MIT License
55.53k stars 8.33k forks source link

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

Open bohyunjung opened 1 month ago

bohyunjung commented 1 month ago

Have you read the Contributing Guidelines on issues?

Motivation

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

Self-service

slorber commented 1 month ago

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 commented 1 month ago

@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 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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. 😅