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.

Sign up for GitHub

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

Jump to bottom

Include details on blog post fields on gatsby-theme-blog #20631

Closed
Phizzard opened this issue Jan 15, 2020 · 3 comments · Fixed by #20632 or #20633
Closed

Include details on blog post fields on gatsby-theme-blog #20631

Phizzard opened this issue Jan 15, 2020 · 3 comments · Fixed by #20632 or #20633
Assignees
@Phizzard
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

@Phizzard
Copy link
Contributor

Summary

When installing and using the gatsby-theme-blog, details past initial installation and configuration are absent. The user has to guess the fields or look through source code to find what blog post fields are available or even required for the theme to work.

Appending information on the blog post fields to the existing readme files of gatsby-theme-blog-core and gatsby-theme-blog should help solve this issue.

Motivation

We should document this to ensure a smooth theme installation and usage and uphold a standard of giving users all the important information.

Draft the doc

Blog Post Fields

The following are the defined blog post fields based on the node interface in the schema

Field Type
id String
title String
body String
slug String
date Date
tags String[]
keywords String[]
excerpt String
@Phizzard Phizzard self-assigned this Jan 15, 2020
@Phizzard Phizzard added type: documentation An issue or pull request for improving or updating Gatsby's documentation topic: themes labels Jan 15, 2020
Phizzard added a commit to Phizzard/gatsby-1 that referenced this issue Jan 15, 2020
@Phizzard
docs(gatsby-theme-blog-core): include Blog Post Fields
60d7828 
Closes gatsbyjs#20631
Phizzard added a commit to Phizzard/gatsby-1 that referenced this issue Jan 15, 2020
@Phizzard
docs(gatsby-theme-blog): Include Blog Post Fields
8e211e6 
Closes gatsbyjs#20631
This was referenced Jan 15, 2020
Merged
Merged
@blainekasten blainekasten added the help wanted Issue with a clear description that the community can help with. label Jan 16, 2020
@blainekasten
Copy link
Contributor

Looks awesome, interested submitting a PR? ❤️

@Phizzard
Copy link
Contributor Author

I have 2 separate PRs already submitted!

blainekasten pushed a commit that referenced this issue Jan 17, 2020
@Phizzard @blainekasten
docs(gatsby-theme-blog): Include Blog Post Fields (#20632)
bb43f5d 
Closes #20631
blainekasten pushed a commit that referenced this issue Jan 17, 2020
@Phizzard @blainekasten
docs(gatsby-theme-blog-core): include Blog Post Fields (#20633)
0b3684e 
Closes #20631
@blainekasten
Copy link
Contributor

MERGED AND THANK YOU!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Phizzard Phizzard

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
Milestone
No milestone
2 participants
@blainekasten @Phizzard