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] - reference guide on "Building an e-commerce site" #10418

Closed
5 tasks
shannonbux opened this issue Dec 11, 2018 · 14 comments
Closed
5 tasks

[docs] - reference guide on "Building an e-commerce site" #10418

shannonbux opened this issue Dec 11, 2018 · 14 comments
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@shannonbux
Copy link
Contributor

shannonbux commented Dec 11, 2018

Issue Context

This issue's purpose is to fill out highly-requested stub articles in Gatsby docs.

Motivation

We are doing this because many people have requested docs which have then been turned into stub articles. In order to fill people's needs, we need to complete the stub articles.

Steps to resolve this issue

Review the Gatsby docs approach

Draft the doc

Open a pull request

  • Open a pull request with your work, including the words "closes #[this issue number]" in the pull request description.
@shannonbux shannonbux added type: documentation An issue or pull request for improving or updating Gatsby's documentation help wanted Issue with a clear description that the community can help with. labels Dec 11, 2018
@gatsbot
Copy link

gatsbot bot commented Feb 7, 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!

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 Feb 7, 2019
@lannonbr lannonbr added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels Feb 13, 2019
@lannonbr
Copy link
Contributor

So there is a E-Commerce tutorial in the docs as well as some videos about making an ecommerce site by @jlengstorf on his twitch stream, so is the structure for this page to have a possible condensed format to guide people on what is available for ecommerce and then link to these various resources?

@lannonbr
Copy link
Contributor

For reference:

@jlengstorf
Copy link
Contributor

The tricky part with e-commerce is that there are so many ways to solve this problem and all of them (or at least the vast majority of them) rely on third-party software like Stripe and Shopify.

We’d probably need something more intense here, similar to the Headless CMS docs, so we can provide a general overview and then list a few options.

@sourabh1031
Copy link

sourabh1031 commented Feb 20, 2019

I would like to work on this if no one is working

@jlengstorf
Copy link
Contributor

@sourabh1031 I know we'd love to have the help. 😄

Did you want to write an overview of e-commerce in Gatsby? That would be a big help.

Thank you!

@raiyansayeed
Copy link

@jlengstorf , is this issue still relevant to work on? I would like to work on it but I don't know what to add. The e-commerce tutorial looks pretty comprehensive already. Would adding some blog references help?
Also as a side request, would it be possible to work on the starter template itself? I would like to make it look a bit "prettier" if that's ok!

@jlengstorf
Copy link
Contributor

@DoctaRay I think this issue might be resolved. @marcysutton can give us a more authoritative answer here.

Regarding styles, we try to keep the starters pretty simple, but we'd love to get a new starter from you and/or a theme that adds more styles.

Thanks!

@marcysutton
Copy link
Contributor

marcysutton commented May 13, 2019

The advanced e-commerce tutorial looks limited to Stripe (and will be moved to Tutorials > Advanced soon). To satisfy this issue, we could create a higher-level e-commerce docs section (potentially) with multiple docs reference guides in it.

Some relevant learning information to consider: tutorials provide step-by-step guidance, while docs reference articles (soon to be called "Reference Guides") are more general in nature. We do need some reference doc material on e-commerce, similar to the Headless CMS docs like @jlengstorf mentioned but outlining the various e-commerce options in Gatsby. Depending on the amount of content, it could either be a single e-commerce reference page or, more likely, a high-level landing page with child pages for each relevant technology or technique. If someone would like to pick that up as part of this issue, I do think it would be useful!

@marcysutton
Copy link
Contributor

Something I'm noticing: it would be really great to have a reference guide on setting up Gatsby with Shopify! As a new Shopify Partner I have no idea what I'm doing...and I'm finding it difficult to understand how to set up a brand-new store (does it have to be public? What API key do I use?). The starter and plugin assume you already use Shopify, and this seems like a use case other people would run into as well.

For an e-commerce section of the Gatsby docs, it would be awesome to list a few options and lead to more specific use case guides (to which we could add on as time goes by)...I could see those docs being extremely useful when building sites for clients.

@jlengstorf
Copy link
Contributor

This is a good idea, @marcysutton. I can put this on my list after the plugin course if no one beats me to it. 😄

@marcysutton marcysutton changed the title Stub article - "Building an e-commerce site" [docs] - reference guide on "Building an e-commerce site" Jun 14, 2019
@kevee
Copy link
Contributor

kevee commented Sep 4, 2019

Started a shopify doc here: https://github.com/kevee/gatsby/blob/docs/shopify-10418/docs/docs/building-an-ecommerce-site-with-shopify.md

@marcysutton
Copy link
Contributor

I just saw your comment, @kevee -- can you open a PR with that Shopify guide? That would be amazing. We want to add a section under Adding Website Functionality for "Building for E-Commerce" or something similar, and this guide could go inside of that.

@marcysutton
Copy link
Contributor

We can now close this doc, as the E-commerce section is represented in the docs with a Shopify Guide (thanks again, @kevee!). Additional guides should be added through new issues. Thanks all!

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. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

9 participants