[Docs] confusing gatsby-config.js

[CHEWX]

Hi,

New to Gatsby and I've noticed that there is no clear link back to gatsby-config.js.

For example if you were to setup a new site and then complete the quick tutorial. You'd then like to finish off with adding Google Analytics.

You search gatsby analytics and get taken to this page — https://github.com/gatsbyjs/gatsby/blob/master/docs/docs/adding-analytics.md

It's not obvious what gatsby-config.js is? Should there be a link back to the docs on this?

Also, the example of Google Analytics. Most people would just copy and paste that into their gatsby-config.js file, however, shouldn't it display like this:

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-plugin-google-analytics',
      options: {
        // replace "UA-XXXXXXXXX-X" with your own Tracking ID
        trackingId: "UA-XXXXXXXXX-X",
      },
    },
  ],
};

This gives a little context.

Might be overly simplifying, just initial feedback.

[wardpeet]

Not sure how we do it for other README.md but that's a great idea!

I would recommend something like

module.exports = {
  // ...gatsby config
  plugins: [
    // ...other gatsby plugins
    {
      resolve: 'gatsby-plugin-google-analytics',
      options: {
        // replace "UA-XXXXXXXXX-X" with your own Tracking ID
        trackingId: "UA-XXXXXXXXX-X",
      },
    },
  ],
};

@CHEWX mind opening a PR for this? That would help us a lot!

@gatsbyjs/docs do any of you have a better solution?

[marcysutton]

Ah yes, I could see how that would be confusing. To clarify your steps, did you search on Google for "adding analytics" and land on the Github page? The page on the Gatsby docs shows the file title (gatsby-config.js), but the Github version does not: https://www.gatsbyjs.org/docs/adding-analytics/#using-gatsby-plugin-google-analytics

I agree that showing a more complete gatsby-config.js structure like what you have here would help in both cases. You could also add a link to this page: https://www.gatsbyjs.org/docs/gatsby-config/#gatsby-config

[gatsbot]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

[gatsbot]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

Thanks again for being part of the Gatsby community!