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

docs(backend-github): add optional branch name configuration

Browse Source
This commit is contained in:
Steph Locke 2021-04-13 15:41:44 +01:00 committed by GitHub
parent 5909a7307d
commit 55d20c19c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/content/docs/github-backend.md
View File

@ -1,9 +1,8 @@
--- ---
title: GitHub
group: Accounts group: Accounts
weight: 30 weight: 30
title: GitHub
--- ---
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. 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.
Because Github [requires a server](https://github.com/netlify/netlify-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication. Because Github [requires a server](https://github.com/netlify/netlify-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication.
@ -17,6 +16,8 @@ To enable basic GitHub authentication:
backend: backend:
name: github name: github
repo: owner-name/repo-name # Path to your GitHub repository repo: owner-name/repo-name # Path to your GitHub repository
# optional, defaults to master
# branch: main
``` ```
## Specifying a status for deploy previews ## Specifying a status for deploy previews