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

docs(gatsby-plugin-google-gtag): clarify that this plugin is inactive in dev #9497

Merged
merged 3 commits into from
Nov 16, 2018

Conversation

talolard
Copy link
Contributor

In reference to #9436 @tylerbuchea

Copy link
Contributor

@pieh pieh left a comment

Choose a reason for hiding this comment

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

Thanks @talolard!

Copy link
Contributor

@pieh pieh left a comment

Choose a reason for hiding this comment

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

Ah, actually, @tylerbuchea made good points

@pieh pieh changed the title Clarify that this plugin is inactive in dev docs(gatsby-plugin-google-gtag): clarify that this plugin is inactive in dev Oct 29, 2018
@DSchau DSchau added the status: awaiting author response Additional information has been requested from the author label Oct 30, 2018
@talolard
Copy link
Contributor Author

As the confused party here I disagree.
I'ma dumb user who just wants google analytics and I have no idea what else gtag does. When I was testing this wanted to see myself in the analytics dashboard and was confused.
I think I am the lowest common denominator of people who would be using this plugin, and more sophisticated users would infer that other gtag features follow the same pattern.

In other words, "This plugin is automatically disabled in development, and enabled in production." doesn't tell me why I'm not seeing myself in google analytics

@pieh
Copy link
Contributor

pieh commented Nov 5, 2018

user who just wants google analytics and I have no idea what else gtag does

But if people are using gtag plugin instead of GA plugin that's on users to know what's the difference (I think). Unless we somewhere recommend that for GA, people should use gtag plugin (I'm not aware of that).

Also I'm not really sure - but can You use gtag without connecting it to GA? If so this would be even more weird reading reference to GA if you aren't even using it with gtag

@pieh
Copy link
Contributor

pieh commented Nov 5, 2018

Also I don't oppose mentioning GA here - but main point should be that gtag is disabled in development. It can expanded as example that if gtag is connected to GA it will not send traffic data to GA

@tylerthebuildor
Copy link
Contributor

I found another Gatsby plugin that also only works in production mode and I really like how they worded their description for this behavior. I thought maybe we could copy them if everyone is cool with it?

Also, it's nice for the consumers of these plugins if we have some consistent messaging across the different README's for similar functionality.

The explanation in the plugin I'm referencing (https://www.gatsbyjs.org/packages/gatsby-plugin-feed/) reads like this:

NOTE: This plugin only generates the /rss.xml file when run in production mode! To test your feed, run: gatsby build && gatsby serve.

So I figured we could update ours to read:

NOTE: This plugin only works in production mode! To test your Global Site Tag is installed and firing events correctly run: gatsby build && gatsby serve.

I hear what you're saying though @talolard. Gtag is new and confusing and it should probably be briefly explained in the README what it is and why you should use it. Which I think @pieh suggested when I opened the original PR but I didn't get around to implementing his suggestion.

So my plan is that we add this NOTE in to describe just the prod vs dev environment differences and then I'm going to open a new PR that puts a description of what services gtag is capable of handling at the very top of the README so it will be clear that this plugin is for Google Analytics, Google Ads, Campaign Manager, Display & Video 360, and Search Ads 360.

I'll include this link to the official Google docs on gtag as well so consumers can read more in-depth if they'd like https://developers.google.com/gtagjs/

Does that sound good to everyone? Can we rally behind that 🎉

@tylerthebuildor
Copy link
Contributor

Also, I think the note should be moved to the top of the README just below the subtext so there is no missing it.

Copy link
Contributor

@pieh pieh left a comment

Choose a reason for hiding this comment

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

Thanks @talolard and @tylerbuchea!

@pieh pieh merged commit a10b83d into gatsbyjs:master Nov 16, 2018
@gatsbot
Copy link

gatsbot bot commented Nov 16, 2018

Holy buckets, @talolard — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

gpetrioli pushed a commit to gpetrioli/gatsby that referenced this pull request Jan 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting author response Additional information has been requested from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants