docs: flowchart and tables for differences between plugins, themes, and starters #21659
Conversation
…lugins, themes, starters
gillkyle
added
the
type: documentation
There was a problem hiding this comment.
Nice work on this Kyle! I made some suggestions below.
I'm trying to think through the format a bit. The plugin vs. theme distinction has to be repeated a bit, same with starters as a snapshot in time. I'm wondering if there is a way to put some of those configuration/usage details up top so that they're covered only once? Let me know what you think.
I thought about this too and thought of the first 3 sections more like overviews, and the latter sections as more granular comparison. I'm open to any suggestions you have! |
Co-Authored-By: LB <[email protected]>
|
|
||
| ### Differences and considerations in maintenance | ||
|
|
||
| When it comes to maintaining a Gatsby site, plugins and themes offer a distinct advantage to starters by being distributed as packages. This means making changes in multiple Gatsby sites is as easy as a new install of an updated package upstream. It's difficult to sync changes across multiple sites derived from the same starter. |
There was a problem hiding this comment.
The phrase "plugins and themes offer a distinct advantage to starters" reads to me like you might choose to use a non-theme plugin rather than a starter to base your site on. Not a blocker as far as I'm concerned but something to think about.
There was a problem hiding this comment.
Yeah I think that would often be the case, to add configuration like linting and tooling to multiple sites. If you think there's a better way to reword this I'm happy to hear what you think! 👍
Co-Authored-By: Aisha Blake <[email protected]>
gillkyle
added
the
status: awaiting reviewer response
Description
This PR creates some markdown tables and a flowchart to evaluate differences in plugins, themes, starters.
The content, including rankings in the tables and flow of the flowchart is definitely subject to some scrutiny. I did the best I could but still think there might be some info lacking here. Getting this info in flowchart format is hard because plugins and themes essentially overlap in every way except for conceptual understanding, hence why I also made the tables.
I'm open to feedback but hope this could help users create a better mental model of Gatsby!
Screenshot Preview
View screenshot
Related Issues
Related to #15616 and this card in the Learning Roadmap: https://github.com/gatsbyjs/gatsby/projects/10#card-30093971