Add warnings to platform guides

This commit is contained in:
Daniel Lautzenheiser
2022-11-07 10:44:42 -05:00
parent c55d1f912f
commit 0fe6989ab3
11 changed files with 34 additions and 9 deletions

View File

@ -3,6 +3,9 @@ group: Guides
title: Docusaurus title: Docusaurus
weight: 80 weight: 80
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide instructs you on how to integrate Static CMS with Docusaurus. This guide instructs you on how to integrate Static CMS with Docusaurus.
### Before you begin ### Before you begin

View File

@ -3,9 +3,12 @@ group: Guides
title: Gatsby title: Gatsby
weight: 10 weight: 10
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide will help you get started using Static CMS and Gatsby. 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 ## Create a new Gatsby site
@ -26,10 +29,9 @@ You will see that there are multiple Markdown files that represent blog posts. O
```yml ```yml
--- ---
title: New Beginnings 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. 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 Far far away, behind the word mountains, far from the countries Vokalia and
Consonantia, there live the blind texts. Consonantia, there live the blind texts.
``` ```
@ -100,7 +102,7 @@ content/
Finally, add the plugin to your `gatsby-config.js`. Finally, add the plugin to your `gatsby-config.js`.
```javascript ```javascript
plugins: [`gatsby-plugin-netlify-cms`] plugins: [`gatsby-plugin-netlify-cms`];
``` ```
### Push to GitHub ### Push to GitHub
@ -129,7 +131,7 @@ Netlify's Identity and Git Gateway services allow you to manage CMS admin users
## Start publishing ## 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. 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.

View File

@ -3,6 +3,9 @@ group: Guides
title: Gridsome title: Gridsome
weight: 70 weight: 70
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide will help you get started using Static CMS and Gridsome. This guide will help you get started using Static CMS and Gridsome.
## How to install Gridsome ## How to install Gridsome

View File

@ -3,7 +3,8 @@ group: Guides
title: Hugo title: Hugo
weight: 20 weight: 20
--- ---
## Introduction
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
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/)! 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/)!

View File

@ -3,7 +3,8 @@ group: Guides
title: Jekyll title: Jekyll
weight: 30 weight: 30
--- ---
## Introduction
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This section will help you integrate Static CMS with a new or existing Jekyll project. This section will help you integrate Static CMS with a new or existing Jekyll project.

View File

@ -3,6 +3,9 @@ group: Guides
title: Middleman title: Middleman
weight: 60 weight: 60
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide will help you get started using Static CMS and Middleman. This guide will help you get started using Static CMS and Middleman.
## Installation ## Installation

View File

@ -3,6 +3,9 @@ group: Guides
title: NextJS title: NextJS
weight: 40 weight: 40
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide will help you get started using Static CMS with NextJS. This guide will help you get started using Static CMS with NextJS.
## Creating a new project ## Creating a new project

View File

@ -3,6 +3,9 @@ group: Guides
title: Nuxt title: Nuxt
weight: 50 weight: 50
--- ---
<Alert severity="warning">This guide is out of date and may not be currently accurate. We are working to update it. Use at your own risk.</Alert>
This guide will walk you through how to integrate Static CMS with Nuxt. This guide will walk you through how to integrate Static CMS with Nuxt.
## Starting With `create-nuxt-app` ## Starting With `create-nuxt-app`

View File

@ -31,4 +31,4 @@ To learn how to query raw content managed by Static CMS and reformat them for de
## Local development ## 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).

View File

@ -283,6 +283,10 @@ const DocsContent = styled('div')(
display: flex; display: flex;
width: 100%; width: 100%;
} }
.MuiAlert-root {
margin-bottom: 16px;
}
`, `,
); );

View File

@ -1,5 +1,6 @@
import { styled, useTheme } from '@mui/material/styles'; import { styled, useTheme } from '@mui/material/styles';
import Typography from '@mui/material/Typography'; import Typography from '@mui/material/Typography';
import Alert from '@mui/material/Alert';
import { MDXRemote } from 'next-mdx-remote'; import { MDXRemote } from 'next-mdx-remote';
import { serialize } from 'next-mdx-remote/serialize'; import { serialize } from 'next-mdx-remote/serialize';
import remarkGfm from 'remark-gfm'; import remarkGfm from 'remark-gfm';
@ -104,13 +105,14 @@ const Docs = ({ docsGroups, title, slug, description = '', source }: DocsProps)
h5: Header5, h5: Header5,
h6: Header6, h6: Header6,
blockquote: Blockquote, blockquote: Blockquote,
CodeTabs,
table: DocsTable, table: DocsTable,
thead: TableHead, thead: TableHead,
tbody: TableBody, tbody: TableBody,
th: TableHeaderCell, th: TableHeaderCell,
td: TableBodyCell, td: TableBodyCell,
a: Anchor, a: Anchor,
CodeTabs,
Alert,
}} }}
/> />
</DocsContent> </DocsContent>