Update docs to add Bitbucket support #1512
Conversation
|
|
||
| To use it in your own project, follow these steps: | ||
|
|
||
| 1. Head over to the [Netlify Identity docs](https://www.netlify.com/docs/identity) and follow the | ||
| steps to get started. | ||
| steps to get started. If your respository is on Bitbucket, you will also need to [add Bitbucket as an authentication provider](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider). |
There was a problem hiding this comment.
Need confirmation that this step is required, and if I've described it correctly in the right place.
|
Deploy preview for netlify-cms-www ready! Built with commit 05aa5c3 |
| backend: | ||
| name: bitbucket | ||
| repo: owner-name/repo-name # Path to your Bitbucket repository | ||
| ``` |
There was a problem hiding this comment.
Need confirmation that these steps/settings are correct.
There was a problem hiding this comment.
@Benaiah confirmed. I removed the part about setting up your own auth server.
|
Deploy preview for cms-demo ready! Built with commit 05aa5c3 |
| | `base_url` | `https://api.netlify.com` (GitHub) or `https://gitlab.com` (GitLab) | OAuth client URL. **Required** when using an external OAuth server or self-hosted GitLab. | | ||
| | `auth_endpoint` | `auth` (GitHub) or `oauth/authorize` (GitLab) | Path to append to `base_url` for authentication requests. Optional. | | ||
| | `base_url` | `https://api.netlify.com` (GitHub, Bitbucket) or `https://gitlab.com` (GitLab) | OAuth client URL. **Required** when using an external OAuth server or self-hosted Git provider. | | ||
| | `auth_endpoint` | `auth` (GitHub, Bitbucket) or `oauth/authorize` (GitLab) | Path to append to `base_url` for authentication requests. Optional. | |
There was a problem hiding this comment.
I pulled default settings from code. Would love another set of eyes to confirm this is all correct.
| @@ -23,6 +23,7 @@ Netlify CMS can be [added to an existing site](https://www.netlifycms.org/docs/a | |||
|
|
|||
| After clicking one of those buttons, you’ll authenticate with GitHub or GitLab and choose a repository name. Netlify will then automatically create a clone of the repository in your GitHub or GitLab account. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. | |||
|
|
|||
| **Note for Bitbucket users:** Netlify CMS supports Bitbucket repositories, but Bitbucket's permissions won't work with the Deploy to Netlify buttons above. You can still set up a repository manually, or follow the [tutorial](https://www.netlifycms.org/docs/add-to-your-site) for adding Netlify CMS to an existing site. | |||
There was a problem hiding this comment.
Let me know if you think this should be worded differently.
As an aside, it would probably make a nice addition to the Netlify CMS blog to write a tutorial for setting up a Bitbucket site from a template.
There was a problem hiding this comment.
Added an issue for the tutorial: https://github.com/netlify/netlify-cms/issues/1513
| | `accept_roles` | none | `git-gateway` only. Limits CMS access to your defined array of user roles. Omitting this field gives access to all registered users. | | ||
| | `branch` | `master` | The branch where published content is stored. All CMS commits and PRs are made to this branch. | | ||
| | `api_root` | `https://api.github.com` (GitHub) or `https://gitlab.com/api/v4` (GitLab) | The API endpoint. Only necessary in certain cases, like with GitHub Enterprise or self-hosted GitLab. | | ||
| | `api_root` | `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab), or `https://api.bitbucket.org/2.0` (Bitbucket) | The API endpoint. Only necessary in certain cases, like with GitHub Enterprise or self-hosted GitLab. | |
There was a problem hiding this comment.
I kept the Bitbucket mentions in the defaults, but removed any mention of self-hosted Bitbucket.
|
I think these are basically good to go now, with one 👍 from another maintainer. |
|
Merging to master for 2.0 release. |
- Summary
Adds/modifies docs content to account for Bitbucket support coming in 2.0. Some portions I've guessed based on code or conversations about possible requirements. Need review from @Benaiah, @erquhart or others who have tested the backend to ensure correctness.
I'll highlight lines that require particular attention.
- Test plan
Check the changed files to see changes; check the deploy preview to see that they render properly.
- Description for the changelog
(implicit in the Bitbucket support changelog entry)
- A picture of a cute animal (not mandatory but encouraged)
