feat: reorganizing the NetlifyCMS Docs navigation (#3766)
This commit is contained in:
Jeremy Zilar
GitHub
parent
3e0d0886d9
commit
6a0e918ffa
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Add to Your Site
|
||||
weight: 20
|
||||
group: start
|
||||
group: intro
|
||||
---
|
||||
|
||||
You can adapt Netlify CMS to a wide variety of projects. It works with any content written in markdown, JSON, YAML, or TOML files, stored in a repo on [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), or [Bitbucket](https://bitbucket.org). You can also create your own custom backend.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Overview
|
||||
weight: 1
|
||||
group: backends
|
||||
group: accounts
|
||||
---
|
||||
|
||||
A backend is JavaScript code that allows Netlify CMS to communicate with a service that stores content - typically a Git host like GitHub or GitLab. It provides functions that Netlify CMS can use to do things like read and update files using API's provided by the service.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Beta Features!
|
||||
weight: 200
|
||||
group: reference
|
||||
group: configuration
|
||||
---
|
||||
|
||||
We run new functionality in an open beta format from time to time. That means that this functionality is totally available for use, and we _think_ it might be ready for primetime, but it could break or change without notice.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Bitbucket
|
||||
group: backends
|
||||
weight: 20
|
||||
group: accounts
|
||||
---
|
||||
For repositories stored on Bitbucket, the `bitbucket` backend allows CMS users to log in directly with their Bitbucket account. Note that all users must have write access to your content repository for this to work.
|
||||
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Collection Types
|
||||
group: start
|
||||
group: collections
|
||||
weight: 27
|
||||
|
||||
---
|
||||
All editable content types are defined in the `collections` field of your `config.yml` file, and display in the left sidebar of the Content page of the editor UI.
|
||||
|
||||
@ -118,4 +119,4 @@ collections:
|
||||
fields:
|
||||
- {label: Name, name: name, widget: string}
|
||||
- {label: Address, name: address, widget: string}
|
||||
```
|
||||
```
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuration Options
|
||||
group: reference
|
||||
group: configuration
|
||||
weight: 23
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Creating Custom Widgets
|
||||
weight: 35
|
||||
group: customization
|
||||
group: fields
|
||||
---
|
||||
|
||||
The NetlifyCMS exposes a `window.CMS` global object that you can use to register custom widgets, previews, and editor plugins. The same object is also the default export if you import Netify CMS as an npm module. The available widget extension methods are:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Deploy Preview Links
|
||||
group: features
|
||||
group: workflow
|
||||
weight: 10
|
||||
---
|
||||
When using the editorial workflow, content editors can create and save content without publishing it
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Examples
|
||||
group: start
|
||||
group: contributing
|
||||
weight: 110
|
||||
|
||||
---
|
||||
|
||||
Do you have a great, open source example? Submit a pull request to this page!
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: External OAuth Clients
|
||||
weight: 40
|
||||
group: backends
|
||||
group: accounts
|
||||
---
|
||||
|
||||
If you would like to facilitate your own OAuth authentication rather than use Netlify's service or implicit grant, you can use one of the community-maintained projects below. Feel free to hit the "Edit this page" button if you'd like to add yours!
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Git Gateway
|
||||
weight: 10
|
||||
group: backends
|
||||
group: accounts
|
||||
---
|
||||
|
||||
[Git Gateway](https://github.com/netlify/git-gateway) is a Netlify open source project that allows you to add editors to your site CMS without giving them direct write access to your GitHub or GitLab repository. (For Bitbucket repositories, use the [Bitbucket backend](#bitbucket-backend) instead.)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitHub
|
||||
weight: 20
|
||||
group: backends
|
||||
group: accounts
|
||||
---
|
||||
|
||||
For repositories stored on GitHub, the `github` backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitLab
|
||||
group: backends
|
||||
weight: 20
|
||||
group: accounts
|
||||
---
|
||||
For repositories stored on GitLab, the `gitlab` backend allows CMS users to log in directly with their GitLab account. Note that all users must have push access to your content repository for this to work.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Introduction
|
||||
title: Overview
|
||||
weight: 1
|
||||
group: start
|
||||
group: intro
|
||||
---
|
||||
|
||||
Netlify CMS is an open source content management system for your Git workflow that enables you to provide editors with a friendly UI and intuitive workflows. You can use it with any static site generator to create faster, more flexible web projects. Content is stored in your Git repository alongside your code for easier versioning, multi-channel publishing, and the option to handle content updates directly in Git.
|
||||
@ -29,7 +29,7 @@ With this in mind, you can:
|
||||
|
||||
If you hook up Netlify CMS to your website, you're basically adding a tool for content editors to make commits to your site repository without touching code or learning Git.
|
||||
|
||||
## Find out more
|
||||
### Find out more
|
||||
|
||||
- Get a feel for the UI in the [demo site](https://cms-demo.netlify.com). (No login required. Click the login button to go straight to the CMS editor UI.)
|
||||
- [Start with a template](../start-with-a-template/) to make a Netlify CMS-enabled site of your own.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Open Authoring
|
||||
group: features
|
||||
group: workflow
|
||||
---
|
||||
|
||||
**This is a [beta feature](/docs/beta-features#open-authoring).**
|
||||
|
||||
@ -1,25 +1,29 @@
|
||||
---
|
||||
title: Update the CMS Version
|
||||
title: Releases
|
||||
weight: 60
|
||||
group: start
|
||||
group: intro
|
||||
---
|
||||
|
||||
|
||||
|
||||
## Update the CMS Version
|
||||
|
||||
The update procedure for your CMS depends upon the method you used to install Netlify CMS.
|
||||
|
||||
## Package Manager
|
||||
### Package Manager
|
||||
|
||||
If you are using a package manager like Yarn or NPM, use their standard procedure to update. This is how both the Hugo and Gatsby starters are set up.
|
||||
|
||||
## CDN
|
||||
### CDN
|
||||
|
||||
If you are using the CMS through a CDN like Unpkg, then that depends on the version tag you are using. You can find the version tag in the `/admin/index.html` file of your site.
|
||||
|
||||
- (Recommended) If you use `^2.0.0`, the CMS does all updates except major versions automatically.
|
||||
- It upgrades to `2.0.1`, `2.1.0`, `2.1.2`.
|
||||
- It does not upgrade to `3.0.0` or higher.
|
||||
- It does not upgrade to beta versions.
|
||||
- It upgrades to `2.0.1`, `2.1.0`, `2.1.2`.
|
||||
- It does not upgrade to `3.0.0` or higher.
|
||||
- It does not upgrade to beta versions.
|
||||
|
||||
- If you use `~2.0.0`, the CMS will do only patch updates automatically.
|
||||
- It upgrades `2.0.1`, `2.0.2`.
|
||||
- It does not upgrade to `2.1.0` or higher.
|
||||
- It does not upgrade beta versions.
|
||||
- It upgrades `2.0.1`, `2.0.2`.
|
||||
- It does not upgrade to `2.1.0` or higher.
|
||||
- It does not upgrade beta versions.
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Start with a Template
|
||||
group: start
|
||||
group: intro
|
||||
weight: 10
|
||||
---
|
||||
You can add Netlify CMS [to an existing site](/docs/add-to-your-site/), but the quickest way to get started is with a template. Found below, our featured templates deploy a bare-bones site and Netlify CMS to Netlify ([what's the difference, you ask?](../intro/#netlify-cms-vs-netlify)), giving you a fully working CMS-enabled site with just a few clicks.
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Test
|
||||
weight: 30
|
||||
group: backends
|
||||
group: accounts
|
||||
|
||||
---
|
||||
|
||||
You can use the `test-repo` backend to try out Netlify CMS without connecting to a Git repo. With this backend, you can write and publish content normally, but any changes will disappear when you reload the page. This backend powers the Netlify CMS [demo site](https://cms-demo.netlify.com/).
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Widgets
|
||||
weight: 30
|
||||
group: reference
|
||||
group: fields
|
||||
---
|
||||
|
||||
Widgets define the data type and interface for entry fields. Netlify CMS comes with several built-in widgets. Click the widget names in the sidebar to jump to specific widget details. We’re always adding new widgets, and you can also [create your own](../custom-widgets)!
|
||||
|
||||
@ -1,18 +1,22 @@
|
||||
menu:
|
||||
docs:
|
||||
- name: start
|
||||
title: Quick Start
|
||||
- name: backends
|
||||
title: Backends
|
||||
- name: features
|
||||
title: Features
|
||||
- name: reference
|
||||
title: Reference
|
||||
- name: intro
|
||||
title: Intro to Netlify CMS
|
||||
- name: accounts
|
||||
title: Account Settings
|
||||
- name: configuration
|
||||
title: Configuring your Site
|
||||
- name: media
|
||||
title: Media
|
||||
- name: workflow
|
||||
title: Workflow
|
||||
- name: collections
|
||||
title: Collections
|
||||
- name: fields
|
||||
title: Fields
|
||||
- name: guides
|
||||
title: Guides
|
||||
title: Platform Guides
|
||||
- name: customization
|
||||
title: Customization
|
||||
title: Customizing Netlify CMS
|
||||
- name: contributing
|
||||
title: Contributing
|
||||
title: Community
|
||||
|
||||
@ -7,3 +7,4 @@
|
||||
/docs/test-drive /docs/start-with-a-template 301
|
||||
/docs/quick-start /docs/add-to-your-site 301
|
||||
/chat https://join.slack.com/t/netlifycms/shared_invite/enQtODE1NTcxODA5Mjg1LTRjYWExM2MyZDJmODA3YmVkMjI2YmQwZDg2ZDUyYTMyM2Y3Zjc1ZTJhNDBkYmMwNjA2ZTkwODY4YjZjNGNlNTE 301
|
||||
/docs/update-the-cms-version /docs/releases 301
|
||||
Loading…
x
Reference in New Issue
Block a user