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

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.
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.