Point to new documentation site
This commit is contained in:
Daniel Lautzenheiser
parent
e34c99f55e
commit
9a2827d94c
@ -95,7 +95,7 @@ backend:
|
||||
|
||||
When debugging the CMS with Git Gateway you must:
|
||||
|
||||
1. Have a Netlify site with [Git Gateway](https://docs.netlify.com/visitor-access/git-gateway/) and [Netlify Identity](https://docs.netlify.com/visitor-access/identity/) enabled. An easy way to create such a site is to use a [template](https://www.netlifycms.org/docs/start-with-a-template/), for example the [Gatsby template](https://app.netlify.com/start/deploy?repository=https://github.com/AustinGreen/gatsby-starter-netlify-cms&stack=cms)
|
||||
1. Have a Netlify site with [Git Gateway](https://docs.netlify.com/visitor-access/git-gateway/) and [Netlify Identity](https://docs.netlify.com/visitor-access/identity/) enabled. An easy way to create such a site is to use a [template](https://www.simplecms.github.io/simple-cms/docs/start-with-a-template/), for example the [Gatsby template](https://app.netlify.com/start/deploy?repository=https://github.com/AustinGreen/gatsby-starter-netlify-cms&stack=cms)
|
||||
2. Tell the CMS the URL of your Netlify site using a local storage item. To do so:
|
||||
|
||||
1. Open `http://localhost:8080/` in the browser
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
|
||||
</div>
|
||||
|
||||
[netlifycms.org](https://www.netlifycms.org/)
|
||||
[simplecms.github.io/simple-cms](https://www.simplecms.github.io/simple-cms/)
|
||||
|
||||
A CMS for static site generators. Give users a simple way to edit
|
||||
and add content to any site built with a static site generator.
|
||||
@ -26,14 +26,14 @@ tweak the main layout of the CMS a bit to fit your own site.
|
||||
When a user navigates to `/admin/` they'll be prompted to log in, and once authenticated
|
||||
they'll be able to create new content or edit existing content.
|
||||
|
||||
Read more about Simple CMS [Core Concepts](https://www.netlifycms.org/docs/intro/).
|
||||
Read more about Simple CMS [Core Concepts](https://www.simplecms.github.io/simple-cms/docs/intro/).
|
||||
|
||||
# Installation and Configuration
|
||||
|
||||
The Simple CMS can be used in two different ways.
|
||||
|
||||
* A Quick and easy install, that requires you to create a single HTML file and a configuration file. All the CMS JavaScript and CSS are loaded from a CDN.
|
||||
To learn more about this installation method, refer to the [Quick Start Guide](https://www.netlifycms.org/docs/quick-start/)
|
||||
To learn more about this installation method, refer to the [Quick Start Guide](https://www.simplecms.github.io/simple-cms/docs/quick-start/)
|
||||
* A complete, more complex install, that gives you more flexibility but requires that you use a static site builder with a build system that supports npm packages.
|
||||
|
||||
# simple-cms-core
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -64,7 +64,7 @@ function SettingsDropdown({ displayUrl, isTestRepo, imageUrl, onLogoutClick, t }
|
||||
<React.Fragment>
|
||||
{isTestRepo && (
|
||||
<AppHeaderTestRepoIndicator
|
||||
href="https://www.netlifycms.org/docs/test-backend"
|
||||
href="https://www.simplecms.github.io/simple-cms/docs/test-backend"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Simple CMS Website & Docs
|
||||
|
||||
This directory builds netlifycms.org. If you'd like to propose changes to the site or docs, you'll find the source files in here.
|
||||
This directory builds simplecms.github.io/simple-cms. If you'd like to propose changes to the site or docs, you'll find the source files in here.
|
||||
|
||||
## Local development
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ To enable it:
|
||||
|
||||
With Bitbucket's Implicit Grant, users can authenticate with Bitbucket directly from the client. To do this:
|
||||
|
||||
1. Follow the [Atlassian docs](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html) to create an OAuth consumer. Make sure you allow `Account/Read` and `Repository/Write` permissions. To use the [Editorial Workflow](https://www.netlifycms.org/docs/configuration-options/#publish-mode), allow `PullRequests/Write` permissions. For the **Callback URL**, enter the address where you access Simple CMS, for example, `https://www.mysite.com/admin/`.
|
||||
1. Follow the [Atlassian docs](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html) to create an OAuth consumer. Make sure you allow `Account/Read` and `Repository/Write` permissions. To use the [Editorial Workflow](https://www.simplecms.github.io/simple-cms/docs/configuration-options/#publish-mode), allow `PullRequests/Write` permissions. For the **Callback URL**, enter the address where you access Simple CMS, for example, `https://www.mysite.com/admin/`.
|
||||
2. Bitbucket gives you a **Key**. Copy this Key and enter it in your Simple CMS `config.yml` file, along with the following settings:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -29,7 +29,7 @@ If you are able to offer up a change to existing content, we welcome this. Once
|
||||
While we work on building this page (and you can help!), here are some links with more information about getting involved:
|
||||
|
||||
* [Setup instructions and Contribution Guidelines](https://github.com/SimpleCMS/simple-cms/blob/master/CONTRIBUTING.md)
|
||||
* [Join our Community Chat](https://netlifycms.org/chat)
|
||||
* [Join our Community Chat](https://simplecms.github.io/simple-cms/chat)
|
||||
* [Code of Conduct](https://github.com/SimpleCMS/simple-cms/blob/master/CODE_OF_CONDUCT.md)
|
||||
* [Project Milestones](https://github.com/SimpleCMS/simple-cms/milestones)
|
||||
* [Good First Issues](https://github.com/SimpleCMS/simple-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22+-label%3Aclaimed)
|
||||
|
||||
@ -33,7 +33,7 @@ The development server now serves your website at `http://localhost:3000`. As yo
|
||||
|
||||
## Push your project to GitHub
|
||||
|
||||
Simple CMS requires a [backend](https://www.netlifycms.org/docs/backends-overview/) to store content. Simple CMS supports using Git hosts, like GitHub or GitLab, as backends. This guide uses GitHub.
|
||||
Simple CMS requires a [backend](https://www.simplecms.github.io/simple-cms/docs/backends-overview/) to store content. Simple CMS supports using Git hosts, like GitHub or GitLab, as backends. This guide uses GitHub.
|
||||
|
||||
```bash
|
||||
# 1. Initialize your local Git repository.
|
||||
@ -209,7 +209,7 @@ collections:
|
||||
- { name: imageUrl, label: ImageURL, widget: string }
|
||||
```
|
||||
|
||||
`config.yml` specifies what kind of content your blog posts have. The content specification enables Simple CMS to edit existing posts and create new ones with the same format. To learn more, read about Simple CMS' [](https://www.netlifycms.org/docs/configuration-options/)[Configuration options](https://www.netlifycms.org/docs/configuration-options/).
|
||||
`config.yml` specifies what kind of content your blog posts have. The content specification enables Simple CMS to edit existing posts and create new ones with the same format. To learn more, read about Simple CMS' [](https://www.simplecms.github.io/simple-cms/docs/configuration-options/)[Configuration options](https://www.simplecms.github.io/simple-cms/docs/configuration-options/).
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
@ -204,7 +204,7 @@ You can see this basic template includes all the fields you've specified in your
|
||||
|
||||
Using `registerEditorComponent` we can register a block level component for the Markdown editor. You can use it to add Hugo's inbuilt shortcodes like `gist`,`youtube` and others as block components to the markdown editor.
|
||||
|
||||
You can refer to [registering editor components](https://www.netlifycms.org/docs/custom-widgets/#registereditorcomponent) for a getting started guide or for creating your own editor components.
|
||||
You can refer to [registering editor components](https://www.simplecms.github.io/simple-cms/docs/custom-widgets/#registereditorcomponent) for a getting started guide or for creating your own editor components.
|
||||
|
||||
**Example**
|
||||
|
||||
|
||||
@ -20,5 +20,5 @@ At its core, Simple CMS is an open-source React app that acts as a wrapper for t
|
||||
- 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 Simple CMS-enabled site of your own.
|
||||
- Configure your existing site by following a [tutorial](../add-to-your-site/) or checking [configuration options](../configuration-options).
|
||||
- Ask questions and share ideas in the Simple CMS [community chat](https://netlifycms.org/chat).
|
||||
- Ask questions and share ideas in the Simple CMS [community chat](https://simplecms.github.io/simple-cms/chat).
|
||||
- Get involved in new developments and become a [contributor](../contributor-guide/).
|
||||
|
||||
@ -15,7 +15,7 @@ If you're starting a new project, the fastest route to publishing on a Jekyll we
|
||||
|
||||
This guide will use the blog you get if you follow the [really excellent official Jekyll step by step tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/) as a starting point. If you're new to Jekyll - I recommended you start by following the tutorial so you know your way around your new blog. Otherwise [you can clone this repo](https://github.com/adamwatters/jekyll-tutorial-with-netlify-cms/tree/without-cms) and checkout the `without-cms` branch.
|
||||
|
||||
|
||||
|
||||
|
||||
## Add Simple CMS
|
||||
|
||||
@ -64,7 +64,7 @@ collections:
|
||||
|
||||
Simple CMS stores content in your online Git repository. Therefore, to make content changes, users need to authenticate with the corresponding Git provider to prove that they have read and write access to that content.
|
||||
|
||||
Follow the directions in the Introduction section to [enable Netlify Identity and Git Gateway services](https://www.netlifycms.org/docs/add-to-your-site/#enable-identity-and-git-gateway) for the backend, then [add the Identity widget](https://www.netlifycms.org/docs/add-to-your-site/#add-the-netlify-identity-widget) to render a login portal on the frontend.
|
||||
Follow the directions in the Introduction section to [enable Netlify Identity and Git Gateway services](https://www.simplecms.github.io/simple-cms/docs/add-to-your-site/#enable-identity-and-git-gateway) for the backend, then [add the Identity widget](https://www.simplecms.github.io/simple-cms/docs/add-to-your-site/#add-the-netlify-identity-widget) to render a login portal on the frontend.
|
||||
|
||||
## CMS Configuration
|
||||
|
||||
@ -190,7 +190,7 @@ Next, copy and paste the following into the collections array in `config.yml` be
|
||||
- { label: 'Body', name: 'body', widget: 'markdown' }
|
||||
```
|
||||
|
||||
Now that we have the `authors` collection configured, we can add an `author` field to the `blog` collection. We'll use the [relation widget](https://www.netlifycms.org/docs/widgets/#relation) to define the relationship between blog posts and authors.
|
||||
Now that we have the `authors` collection configured, we can add an `author` field to the `blog` collection. We'll use the [relation widget](https://www.simplecms.github.io/simple-cms/docs/widgets/#relation) to define the relationship between blog posts and authors.
|
||||
|
||||
```yaml
|
||||
# updated fields in blog collection configuration
|
||||
@ -214,7 +214,7 @@ With that configuration added, you should be able to select the author for a pos
|
||||
|
||||
### About Page
|
||||
|
||||
Our Jekyll blog includes an About page. It would nice to be able to edit that page just like we can edit our blog and author pages. Simple CMS provides [file collections](https://www.netlifycms.org/docs/collection-types/#file-collections) to solve this problem.
|
||||
Our Jekyll blog includes an About page. It would nice to be able to edit that page just like we can edit our blog and author pages. Simple CMS provides [file collections](https://www.simplecms.github.io/simple-cms/docs/collection-types/#file-collections) to solve this problem.
|
||||
|
||||
Copy and paste the following into the collections array in `config.yml`
|
||||
|
||||
|
||||
@ -142,7 +142,7 @@ touch index.html
|
||||
touch config.yml
|
||||
```
|
||||
|
||||
Paste HTML for Simple CMS into your `public/admin/index.html` file (check out the [Add Netlify To Your Site](https://www.netlifycms.org/docs/add-to-your-site/) section for more information)
|
||||
Paste HTML for Simple CMS into your `public/admin/index.html` file (check out the [Add Netlify To Your Site](https://www.simplecms.github.io/simple-cms/docs/add-to-your-site/) section for more information)
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
@ -229,6 +229,6 @@ Netlify's Identity and Git Gateway services allow you to manage CMS admin users
|
||||
|
||||
Great job - you did it! Open your new page via the new Netlify URL, and navigate to `/admin`. If you did everything correct in the previous step, you should now be able to sign up for an account, and log in.
|
||||
|
||||
**Tip:** Signing up with an external provider is the easiest. If you want to sign up by email, you'll have to set up a redirect in your index.js page (which we won't be covering in this guide). For more information, have a look at the [Add To Your Site](https://www.netlifycms.org/docs/add-to-your-site) section.
|
||||
**Tip:** Signing up with an external provider is the easiest. If you want to sign up by email, you'll have to set up a redirect in your index.js page (which we won't be covering in this guide). For more information, have a look at the [Add To Your Site](https://www.simplecms.github.io/simple-cms/docs/add-to-your-site) section.
|
||||
|
||||
Congratulations - you can finally manage your new list of cats!
|
||||
|
||||
@ -71,9 +71,9 @@ After clicking one of those buttons, authenticate with GitHub or GitLab and choo
|
||||
## Access Simple CMS on your new site
|
||||
|
||||
1. The template deploy process sends you an invitation to your new site, sent from `no-reply@netlify.com`.
|
||||
|
||||
|
||||
2. Wait for the deployment to complete, then click the link to accept the invite. Your site will open with a prompt to create a password.
|
||||
|
||||
|
||||
3. Enter a password, sign in, and you’ll go to the CMS. (For future visits, you can go straight to `<yoursiteaddress.com>/admin/`.)
|
||||
|
||||
Try adding and editing posts, or changing the content of the Products page. When you save, the changes are pushed immediately to your Git repository, triggering a build on Netlify, and updating the content on your site. Check out the configuration code by visiting your site repo.
|
||||
|
||||
@ -32,7 +32,7 @@ media_library:
|
||||
|
||||
Once you've finished updating your Simple CMS configuration, the Uploadcare widget will appear when using the image or file widgets.
|
||||
|
||||
**Note:** You'll need to [register the media libraries yourself](https://www.netlifycms.org/blog/2019/07/netlify-cms-gatsby-plugin-4-0-0#using-media-libraries-with-netlify-cms-app).
|
||||
**Note:** You'll need to [register the media libraries yourself](https://www.simplecms.github.io/simple-cms/blog/2019/07/netlify-cms-gatsby-plugin-4-0-0#using-media-libraries-with-netlify-cms-app).
|
||||
|
||||
## Configuring the Uploadcare Widget
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ community:
|
||||
- feature: "Built on the Jamstack"
|
||||
description: "Simple CMS is based on client-side JavaScript, reusable APIs and prebuilt Markup. Compared to server-side CMS like WordPress, this means better performance, higher security, lower cost of scaling, and a better developer experience. You can learn more about the Jamstack on [jamstack.org](https://jamstack.org)."
|
||||
- feature: "Support when you need it"
|
||||
description: "Get up and running with comprehensive [documentation](/docs) and templates or work through difficult problems in our [community chat](https://netlifycms.org/chat)."
|
||||
description: "Get up and running with comprehensive [documentation](/docs) and templates or work through difficult problems in our [community chat](https://simplecms.github.io/simple-cms/chat)."
|
||||
- feature: "A community-driven project you can help evolve"
|
||||
description: "Simple CMS is built by a community of more than 100 contributors — and you can help. Read the [contributing guide](/docs/contributor-guide) to join in."
|
||||
contributors: "Made possible by awesome contributors"
|
||||
|
||||
@ -4,4 +4,4 @@ notifications:
|
||||
project with other devs!
|
||||
published: false
|
||||
title: Chat shoutout
|
||||
url: https://netlifycms.org/chat
|
||||
url: https://simplecms.github.io/simple-cms/chat
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
"reset": "rm -rf .cache"
|
||||
},
|
||||
"author": "",
|
||||
"homepage": "https://www.netlifycms.org/",
|
||||
"homepage": "https://www.simplecms.github.io/simple-cms/",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@emotion/cache": "^10.0.29",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user