Consolidate VCS integration guides with org/user/project/pipeline content #9715
Conversation
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
…anizations-and-integrations-guide.adoc Co-authored-by: BeFunes <benedetta@circleci.com>
…anizations-and-integrations-guide.adoc Co-authored-by: BeFunes <benedetta@circleci.com>
|
|
||
| A CircleCI user account can be integrated with VCS user accounts via _authorization_. | ||
|
|
||
| The following table describes user authorization for the different VCS providers: |
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
| * `bitbucket`: This organization type is created automatically when you authorize CircleCI to access your Bitbucket account via OAuth app. This happens automatically when you sign in to CircleCI with your Bitbucket social login. Your Bitbucket repositories are imported as available projects in CircleCI. You cannot create projects that do not correspond to existing repositories in your Bitbucket personal account or organizations. | ||
|
|
||
| include::ROOT:partial$tips/check-org-type.adoc[Check your organization type] | ||
|
|
There was a problem hiding this comment.
I think it may be helpful here to have a more structured comparisons that shows all the things that change depending on org type, something like this:
There was a problem hiding this comment.
and you could have links that point to all the right anchors in the page. But at least there is a high level view
There was a problem hiding this comment.
THis feels like its coving some of what in this page: https://circleci.com/docs/guides/integration/version-control-system-integration-overview/#code-checkout-and-repository-integration and actually I need to go back to that page and clearly state what we're comparing there - integration type/org type/pipeline type as I can't really answer that question off top of my head! I wonder if we're mixing them up throughout the page
| When you set up a project to build with CircleCI, the following settings are added to the repository using the permissions you gave CircleCI when you signed up: | ||
|
|
||
| - A deploy key that is used to check out your project from GitHub. | ||
| - A service hook (or "push hook") that is used to notify CircleCI when you push to GitHub. |
There was a problem hiding this comment.
This took me a second to process. Why are we calling them "service hooks"? Is this part of historical documentation?
I think it's a bit strange, GitHub docs call them "webhooks" and this is what I've always heard them referred as.
There was a problem hiding this comment.
I have updated to use the standard language we usually use. And yes this is old content from an archived page
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Outdated
Show resolved
Hide resolved
...des/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc
Show resolved
Hide resolved
|
|
||
| #TODO Benny can you help with this section?# | ||
|
|
||
| .GitHub settings showing the CircleCI App integration settings page. |
There was a problem hiding this comment.
Note to self, this is where I stopped reviewing on Dec 8 at 12pm.
| |Mutually exclusive with other VCS authorization | ||
|
|
||
| |GitLab | ||
| |TBC |
There was a problem hiding this comment.
@BeFunes I do however need to fill in this cell in the table. What is the authorization method for GitLab SaaS?
Co-authored-by: BeFunes <benedetta@circleci.com>
| @@ -0,0 +1,53 @@ | |||
| = Create an organization | |||
Description
The main change in this PR is: Create new page: Users, organizations and integrations guide
Bring in all content from VCS integration pages into this one page and describe feature support byt user/org type/integration type/pipeline type.
Archive VCS-specific integration pages
This PR also includes many fixes for cross references which have had to be updated due to the move of all this content
Reasons
Why did you make these changes?
Content Checklist
Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.
Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):