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

Add Sourcing from Flotiq documentation entry #24721

Merged
merged 30 commits into from
Jun 10, 2020
Merged

Add Sourcing from Flotiq documentation entry #24721

merged 30 commits into from
Jun 10, 2020

Conversation

andrzejwp
Copy link
Contributor

Description

This is a Sourcing from Flotiq documentation page that describes how to setup Gatsby for development with content pulled from Flotiq.

Documentation

Related Issues

@andrzejwp andrzejwp requested a review from a team as a code owner June 2, 2020 16:19
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jun 2, 2020
@moonmeister moonmeister added status: needs docs review Pull request related to documentation waiting for review and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jun 2, 2020
@moonmeister
Copy link
Contributor

If you could add it to the table on CMS page: https://www.gatsbyjs.org/docs/headless-cms/ The guide column will link to this document, the docs column will link to the source plugin docs and, starter to your primary starter (probably the one used in the guide).

@andrzejwp
Copy link
Contributor Author

Done, @moonmeister

@moonmeister
Copy link
Contributor

moonmeister commented Jun 5, 2020

@AishaBlake can you help get this reviewed and merged? thanks

@marcysutton marcysutton self-assigned this Jun 8, 2020
Co-authored-by: Muescha <184316+muescha@users.noreply.github.com>
Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, this is going to be great! I ran into some issues with the custom project installation, so that's what most of the comments are about aside from some tweaky style guide stuff. Let me know if you have any questions.

docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Show resolved Hide resolved
andrzejwp and others added 14 commits June 9, 2020 22:14
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
@andrzejwp
Copy link
Contributor Author

Thank you @marcysutton for a thorough review! I included your suggestions and amended the gatsby-node.js file as well as provided the post template. Let me know, please, if you see anything else.

Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

Thanks for making the quick updates! I'm still having an issue with .env in a custom project using the plugin (approach # 2), and I have no idea why. When I copy the file to another project it works fine....and I can't tell why it fails. I checked my code into GitHub if you want to take a look at it: https://github.com/marcysutton/gatsby-flotiq-example

docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
docs/docs/sourcing-from-flotiq.md Outdated Show resolved Hide resolved
@muescha
Copy link
Contributor

muescha commented Jun 10, 2020

@marcysutton

In .env both variables have the GATSBY_ prefix. But in config one key is missing the Gatsby prefix:

baseUrl: process.env.GATSBY_FLOTIQ_BASE_URL,
authToken: process.env.FLOTIQ_API_KEY,

@andrzejwp
Copy link
Contributor Author

@marcysutton

In .env both variables have the GATSBY_ prefix. But in config one key is missing the Gatsby prefix:

baseUrl: process.env.GATSBY_FLOTIQ_BASE_URL,
authToken: process.env.FLOTIQ_API_KEY,

Yes, I amended that yesterday, after the initial set of comments.

@marcysutton I opened a PR to your repo with this fix.

@andrzejwp
Copy link
Contributor Author

@marcysutton can you please take another look. I think I covered everything.

@marcysutton
Copy link
Contributor

Thanks, I must have missed that change! I'm still having issues with the API url, even with the right authToken key and restarting the terminal. Still not sure why!

@moonmeister
Copy link
Contributor

@andrzejwp The docs you've sent me previously for cloud integration and https://github.com/flotiq/gatsby-source-flotiq indicate FLOTIQ_API_KEY as the correct key. Has this changed for some reason?

@andrzejwp
Copy link
Contributor Author

@andrzejwp The docs you've sent me previously for cloud integration and https://github.com/flotiq/gatsby-source-flotiq indicate FLOTIQ_API_KEY as the correct key. Has this changed for some reason?

Good point - the team has recently updated all our starters to use the GATSBY_ prefix. I just sent the updated integration docs via email and updated the source plugin readme as well.

Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

Ah, I had totally missed dotenv in the starter. It works now! Thanks so much, I think we can merge.

@marcysutton marcysutton merged commit c8228f5 into gatsbyjs:master Jun 10, 2020
@marcysutton marcysutton removed the status: needs docs review Pull request related to documentation waiting for review label Jun 10, 2020
@muescha
Copy link
Contributor

muescha commented Jun 10, 2020

@marcysutton i am interested what was wrong. is your final fix in the commits here? https://github.com/marcysutton/gatsby-flotiq-example/commits/master

@marcysutton
Copy link
Contributor

marcysutton commented Jun 10, 2020

@muescha two things: the original doc had an incorrect value for authToken, and was missing the dotenv package to read environment variables. Those things fixed it up! I have updated my repo so it should work now.

@muescha
Copy link
Contributor

muescha commented Jun 10, 2020

thx :)

@andrzejwp
Copy link
Contributor Author

@muescha two things: the original doc had an incorrect value for authToken, and was missing the dotenv package to read environment variables. Those things fixed it up! I have updated my repo so it should work now.

Thanks and apologies - I wanted to keep the examples in the docs concise and I overdid it :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants