Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create gitlab.md #1171

Merged
merged 2 commits into from
Sep 1, 2023
Merged

Create gitlab.md #1171

merged 2 commits into from
Sep 1, 2023

Conversation

dyaffe
Copy link
Member

@dyaffe dyaffe commented Aug 31, 2023

Adding docs for Gitlab


This change is Reviewable

Adding docs for Gitlab
@oliviamiannone oliviamiannone self-requested a review September 1, 2023 18:07
@oliviamiannone oliviamiannone removed their assignment Sep 1, 2023
Copy link
Contributor

@oliviamiannone oliviamiannone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good with a few suggestions inline!

You configure connectors either in the Flow web app, or by directly editing the catalog specification file.
See [connectors](../../../concepts/connectors.md#using-connectors) to learn more about using connectors. The values and specification sample below provide configuration details specific to the GitHub source connector.

### Setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past when I've included a Setup section, it was intended as steps to meet the prerequisites... if the prerequisites aren't self-explanatory. (Hence why some of our connector docs have prereqs but no setup steps listed). This totally works too but just FYI.


### Using OAuth2 to authenticate with GitLab in the Flow web app

* A GitLab user account with access to the repositories of interest, and which is a member of organizations of interest.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be worth noting what role/permissions specifically are required for this to work (https://docs.gitlab.com/ee/user/permissions.html). Also I'd recommend linking to their docs on how to add a member to an org - https://docs.gitlab.com/ee/user/project/members/#add-users-to-a-project

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed these

@dyaffe dyaffe merged commit 377e814 into master Sep 1, 2023
3 checks passed
@github-actions
Copy link

github-actions bot commented Sep 1, 2023

PR Preview Action v1.4.4
🚀 Deployed preview to https://estuary.github.io/flow/pr-preview/pr-1171/
on branch gh-pages at 2023-09-01 19:02 UTC

@dyaffe dyaffe deleted the dyaffe-patch-2 branch October 13, 2023 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants