From 0fe6989ab3396afea00a2422d86c2c3570fa8b31 Mon Sep 17 00:00:00 2001 From: Daniel Lautzenheiser Date: Mon, 7 Nov 2022 10:44:42 -0500 Subject: [PATCH] Add warnings to platform guides --- website/content/docs/docusaurus.mdx | 3 +++ website/content/docs/gatsby.mdx | 12 +++++++----- website/content/docs/gridsome.mdx | 3 +++ website/content/docs/hugo.mdx | 3 ++- website/content/docs/jekyll.mdx | 3 ++- website/content/docs/middleman.mdx | 3 +++ website/content/docs/nextjs.mdx | 3 +++ website/content/docs/nuxt.mdx | 3 +++ website/content/docs/site-generator-overview.mdx | 2 +- website/src/components/docs/DocsContent.tsx | 4 ++++ website/src/pages/docs/[doc].tsx | 4 +++- 11 files changed, 34 insertions(+), 9 deletions(-) diff --git a/website/content/docs/docusaurus.mdx b/website/content/docs/docusaurus.mdx index a0791ad7..62e58178 100644 --- a/website/content/docs/docusaurus.mdx +++ b/website/content/docs/docusaurus.mdx @@ -3,6 +3,9 @@ group: Guides title: Docusaurus weight: 80 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide instructs you on how to integrate Static CMS with Docusaurus. ### Before you begin diff --git a/website/content/docs/gatsby.mdx b/website/content/docs/gatsby.mdx index 9620344e..f9159172 100644 --- a/website/content/docs/gatsby.mdx +++ b/website/content/docs/gatsby.mdx @@ -3,9 +3,12 @@ group: Guides title: Gatsby weight: 10 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide will help you get started using Static CMS and Gatsby. -To get up and running with Gatsby, you'll need to have [Node.js](https://nodejs.org/) installed on your computer. *Note: Gatsby's minimum supported Node.js version is Node 8.* +To get up and running with Gatsby, you'll need to have [Node.js](https://nodejs.org/) installed on your computer. _Note: Gatsby's minimum supported Node.js version is Node 8._ ## Create a new Gatsby site @@ -26,10 +29,9 @@ You will see that there are multiple Markdown files that represent blog posts. O ```yml --- title: New Beginnings -date: "2015-05-28T22:40:32.169Z" +date: '2015-05-28T22:40:32.169Z' description: This is an optional description for SEO and Open Graph purposes, rather than the default generated excerpt. --- - Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. ``` @@ -100,7 +102,7 @@ content/ Finally, add the plugin to your `gatsby-config.js`. ```javascript -plugins: [`gatsby-plugin-netlify-cms`] +plugins: [`gatsby-plugin-netlify-cms`]; ``` ### Push to GitHub @@ -129,7 +131,7 @@ Netlify's Identity and Git Gateway services allow you to manage CMS admin users ## Start publishing -It's time to create your first blog post. Login to your site's `/admin/` page and create a new post by clicking New Blog. Add a title, a date and some text. When you click Publish, a new commit will be created in your GitHub repo with this format `Create Blog "year-month-date-title"`. +It's time to create your first blog post. Login to your site's `/admin/` page and create a new post by clicking New Blog. Add a title, a date and some text. When you click Publish, a new commit will be created in your GitHub repo with this format `Create Blog "year-month-date-title"`. Then Netlify will detect that there was a commit in your repo, and will start rebuilding your project. When your project is deployed you'll be able to see the post you created. diff --git a/website/content/docs/gridsome.mdx b/website/content/docs/gridsome.mdx index e4e39576..6b1c2035 100644 --- a/website/content/docs/gridsome.mdx +++ b/website/content/docs/gridsome.mdx @@ -3,6 +3,9 @@ group: Guides title: Gridsome weight: 70 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide will help you get started using Static CMS and Gridsome. ## How to install Gridsome diff --git a/website/content/docs/hugo.mdx b/website/content/docs/hugo.mdx index 5c13fccd..bba0c80b 100644 --- a/website/content/docs/hugo.mdx +++ b/website/content/docs/hugo.mdx @@ -3,7 +3,8 @@ group: Guides title: Hugo weight: 20 --- -## Introduction + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. This guide will walk you through how to integrate Static CMS with Hugo. This is a good place to start if you want to learn from the ground up how these two tools work together. If you want to get up-and-running quicker, you can use one of the pre-existing and amazing [starter templates](/docs/start-with-a-template/)! diff --git a/website/content/docs/jekyll.mdx b/website/content/docs/jekyll.mdx index 2dd0fef9..d4870546 100644 --- a/website/content/docs/jekyll.mdx +++ b/website/content/docs/jekyll.mdx @@ -3,7 +3,8 @@ group: Guides title: Jekyll weight: 30 --- -## Introduction + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. This section will help you integrate Static CMS with a new or existing Jekyll project. diff --git a/website/content/docs/middleman.mdx b/website/content/docs/middleman.mdx index 7a3c9ddf..6f760a4e 100644 --- a/website/content/docs/middleman.mdx +++ b/website/content/docs/middleman.mdx @@ -3,6 +3,9 @@ group: Guides title: Middleman weight: 60 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide will help you get started using Static CMS and Middleman. ## Installation diff --git a/website/content/docs/nextjs.mdx b/website/content/docs/nextjs.mdx index 8e791aa8..d439f0b0 100644 --- a/website/content/docs/nextjs.mdx +++ b/website/content/docs/nextjs.mdx @@ -3,6 +3,9 @@ group: Guides title: NextJS weight: 40 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide will help you get started using Static CMS with NextJS. ## Creating a new project diff --git a/website/content/docs/nuxt.mdx b/website/content/docs/nuxt.mdx index d5526484..93e3b63c 100644 --- a/website/content/docs/nuxt.mdx +++ b/website/content/docs/nuxt.mdx @@ -3,6 +3,9 @@ group: Guides title: Nuxt weight: 50 --- + +This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk. + This guide will walk you through how to integrate Static CMS with Nuxt. ## Starting With `create-nuxt-app` diff --git a/website/content/docs/site-generator-overview.mdx b/website/content/docs/site-generator-overview.mdx index 3ff4c753..153fe8f2 100644 --- a/website/content/docs/site-generator-overview.mdx +++ b/website/content/docs/site-generator-overview.mdx @@ -31,4 +31,4 @@ To learn how to query raw content managed by Static CMS and reformat them for de ## Local development -If you are experimenting with Static CMS or testing things out, you can connect it to a local Git repository instead of a live one. Learn how to do it [here](/docs/beta-features/#working-with-a-local-git-repository). +If you are experimenting with Static CMS or testing things out, you can connect it to a local Git repository instead of a live one. Learn how to do it [here](/docs/local-backend). diff --git a/website/src/components/docs/DocsContent.tsx b/website/src/components/docs/DocsContent.tsx index 14f0bcf0..d5809025 100644 --- a/website/src/components/docs/DocsContent.tsx +++ b/website/src/components/docs/DocsContent.tsx @@ -283,6 +283,10 @@ const DocsContent = styled('div')( display: flex; width: 100%; } + + .MuiAlert-root { + margin-bottom: 16px; + } `, ); diff --git a/website/src/pages/docs/[doc].tsx b/website/src/pages/docs/[doc].tsx index d9208612..0c43fa30 100644 --- a/website/src/pages/docs/[doc].tsx +++ b/website/src/pages/docs/[doc].tsx @@ -1,5 +1,6 @@ import { styled, useTheme } from '@mui/material/styles'; import Typography from '@mui/material/Typography'; +import Alert from '@mui/material/Alert'; import { MDXRemote } from 'next-mdx-remote'; import { serialize } from 'next-mdx-remote/serialize'; import remarkGfm from 'remark-gfm'; @@ -104,13 +105,14 @@ const Docs = ({ docsGroups, title, slug, description = '', source }: DocsProps) h5: Header5, h6: Header6, blockquote: Blockquote, - CodeTabs, table: DocsTable, thead: TableHead, tbody: TableBody, th: TableHeaderCell, td: TableBodyCell, a: Anchor, + CodeTabs, + Alert, }} />