gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add netlify-cms-backend-* readme for developers (#5257)

Browse Source
This commit is contained in:
Никита
2021-04-14 12:34:21 +02:00
committed by GitHub
parent 72c3765ff7
commit 799779503d
9 changed files with 108 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
packages/netlify-cms-backend-azure/README.md
View File

@ -1,11 +1,13 @@
# Docs coming soon! # Azure backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. An abstraction layer between the CMS and [Azure DevOps](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/)
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `Api` - A wrapper for Azure DevOps REST API.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-azure/README.md)!
`AuthenticationPage` - facilitates implicit authentication flow. Uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md).
Look at tests or types for more info.

18
packages/netlify-cms-backend-bitbucket/README.md
View File

@ -1,11 +1,13 @@
# Docs coming soon! # Bitbucket backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. An abstraction layer between the CMS and [Bitbucket](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/)
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api` and `LargeMedia(LFS)`. With [Editorial Workflow](https://www.netlifycms.org/docs/beta-features/#gitlab-and-bitbucket-editorial-workflow-support) uses pull requests comments to track unpublished entries statuses.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `Api` - A wrapper for Bitbucket REST API.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-bitbucket/README.md)!
`AuthenticationPage` - uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) to facilitate OAuth and implicit authentication.
Look at tests or types for more info.

31
packages/netlify-cms-backend-git-gateway/README.md
View File

@ -1,11 +1,26 @@
# Docs coming soon! # Git Gateway
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. Netlify's [gateway](https://github.com/netlify/git-gateway) to hosted git APIs.
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `Api` and `Implementation` from backend-[github](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-github/README.md)/[gitlab](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-gitlab/README.md)/[bitbacket](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-bitbacket/README.md) extended with Netlify-specific `LargeMedia(LFS)` and `JWT` auth.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-git-gateway/README.md)!
`AuthenticationPage` - uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) and implements Netlify Identity authentication flow.
Look at tests or types for more info.
## Debugging
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)
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
2. Write the below command and press enter: `localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')`
3. To be sure, you can run this command as well: `localStorage.getItem('netlifySiteURL')`
4. Refresh the page
5. You should be able to log in via your Netlify Identity email/password

22
packages/netlify-cms-backend-github/README.md
View File

@ -1,11 +1,17 @@
# Docs coming soon! # GitHub backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. An abstraction layer between the CMS and [Github](https://docs.github.com/en/rest)
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `Api` - A wrapper for GitHub REST API.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-github/README.md)!
`GraphQLApi` - `Api` with `ApolloClient`. [Api docs](https://docs.github.com/en/graphql) and [netlify docs](https://www.netlifycms.org/docs/beta-features/#github-graphql-api).
`AuthenticationPage` - uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) to facilitate OAuth and implicit authentication.
`scripts` - use `createFragmentTypes.js` to create GitHub GraphQL API fragment types.
Look at tests or types for more info.

18
packages/netlify-cms-backend-gitlab/README.md
View File

@ -1,11 +1,13 @@
# Docs coming soon! # GitLab backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. An abstraction layer between the CMS and [GitLab](https://docs.gitlab.com/ee/api/README.html)
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`. With [Editorial Workflow](https://www.netlifycms.org/docs/beta-features/#gitlab-and-bitbucket-editorial-workflow-support) uses merge requests labels to track unpublished entries statuses.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `Api` - A wrapper for GitLab REST API.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-gitlab/README.md)!
`AuthenticationPage` - A component uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) to facilitate OAuth, PKCE and implicit authentication.
Look at tests or types for more info.

14
packages/netlify-cms-backend-proxy/README.md
View File

@ -1,11 +1,9 @@
# Docs coming soon! # Proxy backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. Facilitates [local development](https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository).
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md). An `RPC` wrapper for `netlify-cms-proxy-server`.
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. `AuthenticationPage` - a mock authentication page
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-proxy/README.md)!

22
packages/netlify-cms-backend-test/README.md
View File

@ -1,11 +1,17 @@
# Docs coming soon! # Test backend
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. The backend behind https://cms-demo.netlify.com/.
That's over 20 Readme's! We haven't created one for this package yet, but we will soon. Used for demo purposes only.
In the meantime, you can: ## Code structure
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation `Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on simple JS objects:
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help. ```js
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-backend-test/README.md)! window.repoFiles // json file-system tree
window.repoFilesUnpublished // flat file list
```
`AuthenticationPage` - A component which allow skip `login screen` for demo purposes.
Look at tests or types for more info.

12
packages/netlify-cms-lib-auth/README.md
View File

@ -1,11 +1,3 @@
# Docs coming soon! # Lib Auth
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. Shared components to handle OAuth and implicit authentication flows.
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can:
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-lib-auth/README.md)!

27
packages/netlify-cms-lib-util/README.md
View File

@ -1,11 +1,22 @@
# Docs coming soon! # Lib Util
Netlify CMS was recently converted from a single npm package to a "monorepo" of over 20 packages. Shared utilities to handle various `netlify-cms-backend-*` backends operations.
That's over 20 Readme's! We haven't created one for this package yet, but we will soon.
In the meantime, you can: ## Code structure
This structure should be the same for backends.
At first, look at `Implementation`. This is File Management System API and has factory method for `AuthComponent`.
### File Management System API
An abstraction layer between the CMS and Git-repository manager API.
Used as backend in [cms-core](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-core/README.md).
### Low-level abstractions for Git-repository manager API:
- `API` - used for Entry files
- `git-lfs` - used for Media files
- and over halpful utilities
1. Check out the [main readme](https://github.com/netlify/netlify-cms/#readme) or the [documentation
site](https://www.netlifycms.org) for more info.
2. Reach out to the [community chat](https://netlifycms.org/chat/) if you need help.
3. Help out and [write the readme yourself](https://github.com/netlify/netlify-cms/edit/master/packages/netlify-cms-lib-util/README.md)!