Skip to content

Commit

Permalink
docs: update for 4.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
KaneFreeman committed Jan 3, 2024
1 parent 47957ad commit e3d70d9
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 24 deletions.
9 changes: 0 additions & 9 deletions BREAKING_CHANGES.md

This file was deleted.

6 changes: 1 addition & 5 deletions packages/docs/content/docs/decap-migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Decap / Netlify Migration Guide
weight: 190
---

<Alert severity="warning">
This page is a work in progress! It will likely change before v4.0.0 goes live.
</Alert>

Static CMS is a fork of [Decap](https://github.com/decaporg/decap-cms) (previously Netlify CMS). Many changes have been made, some big, some small.

In this guide, we will walk you through the steps of migrating from Decap or Netlify to Static CMS.
Expand All @@ -33,7 +29,7 @@ Netlify (_remove_):
Static CMS (_add_):

```html
<script src="https://unpkg.com/@staticcms/app@^4.0.0-beta.15/dist/static-cms-app.js"></script>
<script src="https://unpkg.com/@staticcms/app@^4.0.0/dist/static-cms-app.js"></script>
```

### Bundling
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/docs/editorial-workflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ beta: true
---

<Alert severity="warning">
Editorial Workflow currently does not work for the Gitea backend. Support coming soon.
Editorial Workflow is not available for the Gitea backend.
</Alert>

By default, all entries created or edited in Static CMS are committed directly into the main repository branch.
Expand Down
4 changes: 4 additions & 0 deletions packages/docs/content/docs/gitea-backend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ group: Backends
weight: 45
---

<Alert severity="warning">
Gitea backend cannot be used with the Editorial Workflow.
</Alert>

- **Name**: `gitea`

For repositories stored on Gitea, the `gitea` backend allows CMS users to log in directly with their Gitea account. Note that all users must have push access to your content repository for this to work.
Expand Down
12 changes: 4 additions & 8 deletions packages/docs/content/docs/migration-guide-v4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: How to Upgrade to v4
weight: 101
---

<Alert severity="warning">
This page is a work in progress! It will likely change before v4.0.0 goes live.
</Alert>

Static CMS v4 introduces:

- [Custom themes](/docs/custom-theme)
Expand All @@ -23,23 +19,23 @@ Please [report any issues](https://github.com/StaticJsCMS/static-cms/issues/new)
To install the latest version of Static CMS:

```bash
npm install @staticcms/core@^4.0.0-beta.15
npm install @staticcms/core@^4.0.0
```

Or if you are using yarn:

```bash
yarn add @staticcms/core@^4.0.0-beta.15
yarn add @staticcms/core@^4.0.0
```

If you are using a CDN to load Static CMS, simply change your URLs:

```html
<link rel="stylesheet" href="https://unpkg.com/@staticcms/app@^4.0.0-beta.15/dist/main.css" />
<link rel="stylesheet" href="https://unpkg.com/@staticcms/app@^4.0.0/dist/main.css" />
```

```html
<script src="https://unpkg.com/@staticcms/app@^4.0.0-beta.15/dist/static-cms-app.js"></script>
<script src="https://unpkg.com/@staticcms/app@^4.0.0/dist/static-cms-app.js"></script>
```

## View Filters
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/docs/open-authoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ beta: true
---

<Alert severity="warning">
Open Authoring only works with the [GitHub backend](/docs/github-backend) and must be used with the [Editorial Workflow](/docs/editorial-workflow).
Open Authoring is only available with the [GitHub backend](/docs/github-backend) and must be used with the [Editorial Workflow](/docs/editorial-workflow).
</Alert>

When using the [GitHub backend](/docs/github-backend), you can use Static CMS to accept contributions from GitHub users without giving them access to your repository. When they make changes in the CMS, the CMS forks your repository for them behind the scenes, and all the changes are made to the fork. When the contributor is ready to submit their changes, they can set their draft as ready for review in the CMS. This triggers a pull request to your repository, which makes it appear in the Dashboard for maintainers.
Expand Down
6 changes: 6 additions & 0 deletions packages/docs/content/releases.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
{
"releases": [
{
"date": "2024-01-03T10:00:00.000Z",
"version": "v4.0.0",
"type": "major",
"description": "Editorial workflow, open authoring and theming"
},
{
"date": "2024-01-02T11:00:00.000Z",
"version": "v4.0.0-beta.17",
Expand Down

0 comments on commit e3d70d9

Please sign in to comment.