diff --git a/packages/netlify-cms-backend-azure/README.md b/packages/netlify-cms-backend-azure/README.md index 3d236327..78bbc746 100644 --- a/packages/netlify-cms-backend-azure/README.md +++ b/packages/netlify-cms-backend-azure/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +An abstraction layer between the CMS and [Azure DevOps](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/) -In the meantime, you can: +## Code structure -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-backend-azure/README.md)! +`Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`. + +`Api` - A wrapper for Azure DevOps REST API. + +`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. diff --git a/packages/netlify-cms-backend-bitbucket/README.md b/packages/netlify-cms-backend-bitbucket/README.md index 9a92046e..6c01511e 100644 --- a/packages/netlify-cms-backend-bitbucket/README.md +++ b/packages/netlify-cms-backend-bitbucket/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +An abstraction layer between the CMS and [Bitbucket](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/) -In the meantime, you can: +## Code structure -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-backend-bitbucket/README.md)! +`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. + +`Api` - A wrapper for Bitbucket REST 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. + +Look at tests or types for more info. diff --git a/packages/netlify-cms-backend-git-gateway/README.md b/packages/netlify-cms-backend-git-gateway/README.md index 8373c962..2b0c9172 100644 --- a/packages/netlify-cms-backend-git-gateway/README.md +++ b/packages/netlify-cms-backend-git-gateway/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +Netlify's [gateway](https://github.com/netlify/git-gateway) to hosted git APIs. -In the meantime, you can: +## Code structure -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-backend-git-gateway/README.md)! +`Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`. + +`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. + +`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 diff --git a/packages/netlify-cms-backend-github/README.md b/packages/netlify-cms-backend-github/README.md index 8eb3f668..f36a0d48 100644 --- a/packages/netlify-cms-backend-github/README.md +++ b/packages/netlify-cms-backend-github/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +An abstraction layer between the CMS and [Github](https://docs.github.com/en/rest) -In the meantime, you can: +## Code structure -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-backend-github/README.md)! +`Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`. + +`Api` - A wrapper for GitHub REST API. + +`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. diff --git a/packages/netlify-cms-backend-gitlab/README.md b/packages/netlify-cms-backend-gitlab/README.md index a01b5e24..a7f03c88 100644 --- a/packages/netlify-cms-backend-gitlab/README.md +++ b/packages/netlify-cms-backend-gitlab/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +An abstraction layer between the CMS and [GitLab](https://docs.gitlab.com/ee/api/README.html) -In the meantime, you can: +## Code structure -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-backend-gitlab/README.md)! +`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. + +`Api` - A wrapper for GitLab REST API. + +`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. diff --git a/packages/netlify-cms-backend-proxy/README.md b/packages/netlify-cms-backend-proxy/README.md index 3907c5c5..581d553e 100644 --- a/packages/netlify-cms-backend-proxy/README.md +++ b/packages/netlify-cms-backend-proxy/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +Facilitates [local development](https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository). -In the meantime, you can: +## Code structure -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-backend-proxy/README.md)! +`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`. + +`AuthenticationPage` - a mock authentication page diff --git a/packages/netlify-cms-backend-test/README.md b/packages/netlify-cms-backend-test/README.md index 1313a3b3..41333c51 100644 --- a/packages/netlify-cms-backend-test/README.md +++ b/packages/netlify-cms-backend-test/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +The backend behind https://cms-demo.netlify.com/. +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 - 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-backend-test/README.md)! +`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: + +```js +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. diff --git a/packages/netlify-cms-lib-auth/README.md b/packages/netlify-cms-lib-auth/README.md index dfd06420..5c2cab82 100644 --- a/packages/netlify-cms-lib-auth/README.md +++ b/packages/netlify-cms-lib-auth/README.md @@ -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. -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)! +Shared components to handle OAuth and implicit authentication flows. diff --git a/packages/netlify-cms-lib-util/README.md b/packages/netlify-cms-lib-util/README.md index 5e1eb5b5..66712c8b 100644 --- a/packages/netlify-cms-lib-util/README.md +++ b/packages/netlify-cms-lib-util/README.md @@ -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. -That's over 20 Readme's! We haven't created one for this package yet, but we will soon. +Shared utilities to handle various `netlify-cms-backend-*` backends operations. -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)!