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

Document stub node "Client data fetching" with relevant information #10373

Closed
tusharjoshi opened this issue Dec 9, 2018 · 8 comments
Closed
Assignees

Comments

@tusharjoshi
Copy link

Provide relevant documentation to change this stub into actual document for the section Client data fetching

Located at [Site URL here] (https://www.gatsbyjs.org/docs/client-data-fetching/#client-data-fetching)

Recently there is one tweet regarding the state of documentation for this section.

@tusharjoshi
Copy link
Author

I need information about the context of Client data fetching which should be documented on this page. Any pointers bout youtube videos, blog posts, code comments or any place where this functionality is discussed will help.

Is this page title referring to fetching data after the site is built and deployed? Or this is at the time of building the site. This node is under section "Use Cases for Gatsby" hence not sure, any information about these from the developers will help me proceed.

@btk
Copy link
Contributor

btk commented Dec 10, 2018

I would say the title is not so clear, If I wanted to write something under that title, I probably wouldn't. The stubs should explain the context of that page with at least one paragraph I think.

It does not look very inviting to edit or contribute to be honest.

@tusharjoshi
Copy link
Author

Currently 6 nodes under the section Use cases with Gatsby are stubs. If this title is unclear then we should remove that stub or update it so someone can contribute to make it complete.

I am very new to Gatsby and cannot comment on what shall be the correct title, need help from Gatsby veterans here.

@amberleyromo
Copy link
Contributor

Hi @tusharjoshi -- great observation, thank you! We're always trying to expand and cover as much as we can in docs. In this case, we're removing some of these stubs from the sidebar, until we can better define the question we need to answer.

Can you go into more specifics about the problem you were trying to solve, that led you to this doc page?

@tusharjoshi
Copy link
Author

Hi @amberleyromo Recently there is one tweet here regarding the state of documentation for this section. As I watch @gatsbyjs tweeter feed I came across that tweet and wanted to provide solution by contributing here.

This is 24pullrequest project month and I keep searching for small contributions which can be done in opensource projects. Thanks.

@shannonbux
Copy link
Contributor

Ok, I searched my slack history and found that when @KyleAMathews suggested this doc, another way to name it could be "runtime data fetching" or "dynamic data fetching", though we concluded to not use "dynamic" since it isn't well-defined.

The two main problem we were trying to solve:

  • clarify what Gatsby does at build time and at runtime
  • demonstrate and teach how to use Gatsby to build apps

I'm not sure I know enough to make the final call here; does this context help explain this stub article's purpose and whether it's worth creating it?

@jgierer12
Copy link
Contributor

Sounds like this has some overlap with the blog post - Gatsby for Apps. @tusharjoshi maybe you'll want to read that to get an idea of what the guide should cover.

@amberleyromo
Copy link
Contributor

Closing! This stub was built out in #10516

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

No branches or pull requests

5 participants