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] [workflows] Installing and using Contentful #13945

Closed
7 tasks
ghost opened this issue May 9, 2019 · 6 comments
Closed
7 tasks

[docs] [workflows] Installing and using Contentful #13945

ghost opened this issue May 9, 2019 · 6 comments
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@ghost
Copy link

ghost commented May 9, 2019

Part of the Top 25 Learning Workflows initiative. See #13708 for the meta issue that this issue falls under.

User story

As a new Gatsby user, I want to create a blog/site that pulls content and images from Contentful and allows me to query it.

Evaluation

Search Discover Complete Linked Tone Style Overall
😄 😐 😐 😞 😐 😄 😐

Steps taken to implement

  1. Searchability
    1. Searched gatsby contentful on Google. clicked second link.
    2. First link was to Contentful site
  2. Discoverability
    1. Searchbar:
      1. Searched gatsby contentful in search bar; only blog articles show up.
      2. Searchedcontentful; Sourcing from Contentful pops up.
        [rec] searching for gatsby contentful should bring up Sourcing from Contentful as well
      3. Some blogs do not mention Sourcing from Contentful
    2. Clickpath on .org:
      1. Clicked docs
      2. Clicked Guides > Sourcing Content and Data > Sourcing from (Headless) CMSs > Sourcing from Contentful
      3. Discoverable
  3. Completeness
    1. Followed steps in Sourcing from Contentful
    2. Clicked on Link Quick Start guide which actually links to Gatsby.js Documentation.
      [rec] actually link to Quick Start, the link above goes to docs.
    3. Followed steps in Quick Start.
    4. Jumped back to Sourcing from Contentful
      1. Followed prerequisites
        [rec] include prerequisite of contentful site and give an option for Getting started with Contentful, steps in this blog are pretty clear and helpful.
      2. The Pulling data in and pushing data out section does not really fit here at all.
        [rec] remove Pulling data in and pushing data out
      3. Followed install and how to use
    5. I was able to get the plugin running with sh gatsby develop, but no more information provided after that.
      [rec] Add another section for how to actually use the data, or at least a general query in GraphQL
  4. Linkedness
    1. The links could be much better.
      [rec] There should be links to help get a better understanding in general. i.e. GraphQL at build time, GraphQL schema, etc.
      [rec] Link the user to getting started content with Contentful
      [rec] Provide a Learn More with more indepth articles on using Contentful with Gatsby
  5. Tone
    1. Overall easy to read, but I would suggest rearranging parts of the content and buffing up the wording in areas.
  6. Style
    1. Nothing obviously wrong

Recommendations

  • searching for gatsby contentful should bring up Sourcing from Contentful as well
  • include prerequisite of contentful site and give an option for Getting started with Contentful, steps in this blog are pretty clear and helpful.
  • remove Pulling data in and pushing data out
  • Add another section for how to actually use the data, or at least a general query in GraphQL
  • There should be links to help get a better understanding in general. i.e. GraphQL at build time, GraphQL schema, etc.
  • Link the user to getting started content with Contentful
  • Provide a Learn More with more indepth articles on using Contentful with Gatsby
abhinavprasad47 added a commit to abhinavprasad47/gatsby that referenced this issue May 10, 2019
@freiksenet freiksenet added type: documentation An issue or pull request for improving or updating Gatsby's documentation type: feature or enhancement help wanted Issue with a clear description that the community can help with. labels May 16, 2019
@alexluong
Copy link
Contributor

Hey @freiksenet, I'd love to help with this. I have some experiences building sites with Gatsby and Contentful.

Within those recommendations by @jasonellington, how should I go about tackling them?

@jonniebigodes
Copy link

@alexluong if you want see my reproduction for this issue and take it from there.

@alexluong
Copy link
Contributor

@jonniebigodes That's a great starting point. I'd take that into consideration for the documentation page.

@gatsbot
Copy link

gatsbot bot commented Jul 4, 2019

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!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contributefor more information about opening PRs, triaging issues, and contributing!

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

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Jul 4, 2019
@ghost
Copy link
Author

ghost commented Jul 11, 2019

@prestonso is this still a priority?

@gatsbot
Copy link

gatsbot bot commented Jul 22, 2019

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.

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community!

@gatsbot gatsbot bot closed this as completed Jul 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

4 participants