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

chore(docs): Clean up Headless CMS documentation links #34350

Merged
merged 8 commits into from
Jan 6, 2022
Merged

chore(docs): Clean up Headless CMS documentation links #34350

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5a9d591
update docs on building with components to link to correct tutorial -…
aghreed Dec 30, 2021
19fd41f
update datocms starter link
aghreed Dec 30, 2021
7e35a6e
update starters links to include older versions of gatsby as well as …
aghreed Jan 3, 2022
90101f8
update version of gatsby used in other linked starters
aghreed Jan 3, 2022
149eb3c
remove all starter links that are not v4 based
aghreed Jan 3, 2022
131dd83
formatting
aghreed Jan 3, 2022
8bfd6b5
add prismic starter and cosmic guide links
aghreed Jan 4, 2022
680ae6c
add sanity starter link and update strapi guide
aghreed Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/conceptual/building-with-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ pages are React components but very often these components are just wrappers aro
`src/templates/post.js` is an example of a page component. It queries GraphQL
for markdown data and then renders the page using this data.

See [part seven](/docs/tutorial/part-7/) of the tutorial for a detailed
See [part six](/docs/tutorial/part-6/) of the tutorial for a detailed
introduction to programmatically creating pages.

Example:
Expand Down
61 changes: 30 additions & 31 deletions docs/docs/how-to/sourcing-data/headless-cms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,39 @@ We've included setup guides, and links to the integration documentation as well

The following CMSs have high popularity among Gatsby users and support key functionality like content previews and incremental builds. If you're choosing between CMSs, we recommend reading the [Choosing Your CMS(s)](https://www.gatsbyjs.com/docs/conceptual/choosing-a-cms/) documentation.

| CMS | Guides | Plugin Docs | Official Starter |
| --------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------- |
| [Contentful](https://www.contentful.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-contentful/) | [docs](/plugins/gatsby-source-contentful) | [starter](/starters/contentful/starter-gatsby-blog/) |
| [WordPress](https://www.wordpress.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-wordpress/) | [docs](/plugins/gatsby-source-wordpress) | |
| [Shopify](https://www.shopify.com/) | | [docs](/plugins/gatsby-source-shopify) | |
| [Sanity](https://www.sanity.io/) | [guide](/docs/sourcing-from-sanity) | [docs](/plugins/gatsby-source-sanity/) | [starter](/starters/sanity-io/example-company-website-gatsby-sanity-combo/) |
| [Strapi](https://strapi.io/) | [guide](/blog/2018-1-18-strapi-and-gatsby/) | [docs](/plugins/gatsby-source-strapi) | [starter](/starters/strapi/strapi-starter-gatsby-blog/) |
| [Contentstack](https://www.contentstack.com/) | [guide](/docs/sourcing-from-contentstack) | [docs](/plugins/gatsby-source-contentstack) | [starter](/starters/contentstack/gatsby-starter-contentstack/) |
| [DatoCMS](https://www.datocms.com/) | [guide](https://www.gatsbyjs.com/guides/datocms/) | [docs](/plugins/gatsby-source-datocms) | [starter](/starters/datocms/gatsby-portfolio/) |
| [Drupal](https://www.drupal.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-drupal/) | [docs](/plugins/gatsby-source-drupal) | |
| [Prismic](https://www.prismic.io/) | [guide](/docs/how-to/sourcing-data/sourcing-from-prismic/) | [docs](/plugins/gatsby-source-prismic) | [starter](/starters/LekoArts/gatsby-starter-prismic/) |
| [NetlifyCMS](https://www.netlifycms.org/) | [guide](/docs/how-to/sourcing-data/sourcing-from-netlify-cms/) | [docs](/plugins/gatsby-plugin-netlify-cms) | [starter](/starters/netlify-templates/gatsby-starter-netlify-cms/) |
| CMS | Guides | Plugin Docs | Official Starter |
| --------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------ |
| [Contentful](https://www.contentful.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-contentful/) | [docs](/plugins/gatsby-source-contentful) | [starter](/starters/contentful/starter-gatsby-blog/) |
| [WordPress](https://www.wordpress.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-wordpress/) | [docs](/plugins/gatsby-source-wordpress) | [starter](/starters/gatsbyjs/gatsby-starter-wordpress-blog) |
| [Shopify](https://www.shopify.com/) | [guide](/docs/building-an-ecommerce-site-with-shopify/) | [docs](/plugins/gatsby-source-shopify) | [starter](/starters/gatsbyjs/gatsby-starter-shopify/) |
| [Sanity](https://www.sanity.io/) | [guide](/docs/sourcing-from-sanity) | [docs](/plugins/gatsby-source-sanity/) |
| [Strapi](https://strapi.io/) | [guide](/blog/2018-1-18-strapi-and-gatsby/) | [docs](/plugins/gatsby-source-strapi) | |
| [Contentstack](https://www.contentstack.com/) | [guide](/docs/sourcing-from-contentstack) | [docs](/plugins/gatsby-source-contentstack) |
| [DatoCMS](https://www.datocms.com/) | [guide](https://www.gatsbyjs.com/guides/datocms/) | [docs](/plugins/gatsby-source-datocms) | [starter](/starters/datocms/gatsby-blog-demo/) |
| [Drupal](https://www.drupal.com/) | [guide](/docs/how-to/sourcing-data/sourcing-from-drupal/) | [docs](/plugins/gatsby-source-drupal) | |
| [Prismic](https://www.prismic.io/) | [guide](/docs/how-to/sourcing-data/sourcing-from-prismic/) | [docs](/plugins/gatsby-source-prismic) | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't limit ourselves on the existing starters we have, e.g. my own gatsby-starter-prismic is quite outdated. Many of the CMSs have their own projects updated.

This one here for example is v4: https://github.com/prismicio/gatsby-blog

So it would be a worthwhile investment of time to check out their docs :)

| [NetlifyCMS](https://www.netlifycms.org/) | [guide](/docs/how-to/sourcing-data/sourcing-from-netlify-cms/) | [docs](/plugins/gatsby-plugin-netlify-cms) | [starter](/starters/netlify-templates/gatsby-starter-netlify-cms/) |

## Other CMSs

| CMS | Guides | Plugin Docs | Official Starter |
| ----------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- |
| [Cosmic](https://cosmicjs.com/) | [guide](/blog/2018-06-07-build-a-gatsby-blog-using-the-cosmic-js-source-plugin/) | [docs](/plugins/gatsby-source-cosmicjs) | [starters](/starters/?s=cosmic&v=2) |
| [ButterCMS](https://buttercms.com/) | [guide](/docs/sourcing-from-buttercms/) | [docs](/plugins/gatsby-source-buttercms) | [starter](/starters/ButterCMS/gatsby-starter-buttercms/) |
| [Ghost](https://ghost.org/) | [guide](/docs/sourcing-from-ghost/) | [docs](/plugins/gatsby-source-ghost/) | [starter](/starters/TryGhost/gatsby-starter-ghost/) |
| [Kontent by Kentico](https://kontent.ai/) | [guide](/docs/sourcing-from-kentico-kontent) | [docs](/plugins/@kentico/gatsby-source-kontent) | [starter](/starters/Kentico/gatsby-starter-kontent-lumen/) |
| [Directus](https://directus.io/) | | [docs](/plugins/@directus/gatsby-source-directus/) | |
| [GraphCMS](https://graphcms.com/) | [guide](/docs/sourcing-from-graphcms) | [docs](/plugins/gatsby-source-graphql) | [starter](/starters/GraphCMS/gatsby-graphcms-tailwindcss-example/) |
| [Storyblok](https://www.storyblok.com/) | [guide](https://www.storyblok.com/tp/gatsby-multilanguage-website-tutorial) | [docs](/plugins/gatsby-source-storyblok) | [starter](https://github.com/storyblok/gatsby-storyblok-boilerplate) |
| [Cockpit](https://getcockpit.com/) | | [docs](/plugins/gatsby-plugin-cockpit) | |
| [CraftCMS](https://craftcms.com/) | | [docs](/plugins/gatsby-source-craftcms) | |
| [Agility CMS](https://agilitycms.com/) | [guide](/docs/sourcing-from-agilitycms/) | [docs](/plugins/@agility/gatsby-source-agilitycms/) | [starter](/starters/agility/agility-gatsby-starter/) |
| [Prepr CMS](https://prepr.io/) | [guide](https://docs.prepr.io/docs/frontend-integrations/v1/gatsby) | | |
| [Forestry](https://forestry.io/) | [guide](/docs/sourcing-from-forestry/) | | |
| [Gentics Mesh](https://getmesh.io) | [guide](/docs/sourcing-from-gentics-mesh) | | |
| [Seams-CMS](https://seams-cms.com/) | [guide](/docs/sourcing-from-seams-cms) | | |
| [Builder.io](https://www.builder.io/) | [guide](/docs/sourcing-from-builder-io/) | [docs](/plugins/@builder.io/gatsby/) | [starter](https://github.com/BuilderIO/gatsby-starter-builder) |
| [Flotiq](https://flotiq.com/) | [guide](/docs/sourcing-from-flotiq/) | [docs](/plugins/gatsby-source-flotiq) | [starter](https://github.com/flotiq/gatsby-starter-blog) |
| [Tina](https://tina.io) | [guide](https://tina.io/guides/#gatsby) | [docs](https://tina.io/docs/integrations/gatsby/) | |
| CMS | Guides | Plugin Docs | Official Starter |
| ----------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------- |
| [Cosmic](https://cosmicjs.com/) | [guide](/blog/2018-06-07-build-a-gatsby-blog-using-the-cosmic-js-source-plugin/) | [docs](/plugins/gatsby-source-cosmicjs) | [starter](https://github.com/cosmicjs/gatsby-blog-cosmicjs) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we're updating this page, I'd say we should remove outdated guides like linking to a blogpost from 2018 and instead link docs that CMS own: https://docs.cosmicjs.com/guides/gatsby

If we don't have our own guide and the CMS has a guide, let's link it!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. My only concern here is putting Gatsby in the "passenger seat" rather than the "drivers seat" within guides that we link to from here, but I suppose that's not entirely bad.

| [ButterCMS](https://buttercms.com/) | [guide](/docs/sourcing-from-buttercms/) | [docs](/plugins/gatsby-source-buttercms) | |
| [Ghost](https://ghost.org/) | [guide](/docs/sourcing-from-ghost/) | [docs](/plugins/gatsby-source-ghost/) | [starter](/starters/TryGhost/gatsby-starter-ghost/) |
| [Kontent by Kentico](https://kontent.ai/) | [guide](/docs/sourcing-from-kentico-kontent) | [docs](/plugins/@kentico/gatsby-source-kontent) | |
| [Directus](https://directus.io/) | | [docs](/plugins/@directus/gatsby-source-directus/) | |
| [GraphCMS](https://graphcms.com/) | [guide](/docs/sourcing-from-graphcms) | [docs](/plugins/gatsby-source-graphql) | |
| [Storyblok](https://www.storyblok.com/) | [guide](https://www.storyblok.com/tp/gatsby-multilanguage-website-tutorial) | [docs](/plugins/gatsby-source-storyblok) | |
| [Cockpit](https://getcockpit.com/) | | [docs](/plugins/gatsby-plugin-cockpit) | |
| [CraftCMS](https://craftcms.com/) | | [docs](/plugins/gatsby-source-craftcms) | |
| [Agility CMS](https://agilitycms.com/) | [guide](/docs/sourcing-from-agilitycms/) | [docs](/plugins/@agility/gatsby-source-agilitycms/) | |
| [Prepr CMS](https://prepr.io/) | [guide](https://docs.prepr.io/docs/frontend-integrations/v1/gatsby) | | |
| [Forestry](https://forestry.io/) | [guide](/docs/sourcing-from-forestry/) | | |
| [Gentics Mesh](https://getmesh.io) | [guide](/docs/sourcing-from-gentics-mesh) | | |
| [Seams-CMS](https://seams-cms.com/) | [guide](/docs/sourcing-from-seams-cms) | | |
| [Builder.io](https://www.builder.io/) | [guide](/docs/sourcing-from-builder-io/) | [docs](/plugins/@builder.io/gatsby/) | |
| [Flotiq](https://flotiq.com/) | [guide](/docs/sourcing-from-flotiq/) | [docs](/plugins/gatsby-source-flotiq) | |

## Integrating with other CMSs

Expand Down