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

Add Pull Requests to docs #8376

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/img/pull-request-merged.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/pull-request-open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/pull-request-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/howto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ has_toc: false

* [Branch Protection](/howto/protect-branches.html) prevents commits directly to a branch. This is a good way to enforce good practice and make sure that changes to important branches are only done by a merge.

## Pull Requests

* Improve collaboration over data with [Pull Requests](/howto/pull-requests.html).

## lakeFS Sizing Guide

* This [comprehensive guide](/howto/sizing-guide.html) details all you need to know to correctly size and test your lakeFS deployment for production use at scale, including:
Expand Down
50 changes: 50 additions & 0 deletions docs/howto/pull-requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Pull Requests
description: Improve collaboration over data with Pull Requests.
parent: How-To
redirect_from:
- /reference/pull_requests.html
---

# Pull Requests
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please add an RBAC section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AFAIK (maybe @N-o-Z will know better), this feature is currently available to all users.
Plus, if an admin will change the RBAC conf for PRfD, the tab (and "Create PR" button) will still show up for users, but yield errors when trying to act -
So maybe it's better to leave RBAC out of this doc until it's more mature?


A pull request is a proposal to merge a set of changes from one branch into another.
In a pull request, collaborators can review the proposed set of changes before they integrate the changes.
Pull requests display the differences, or diffs, between the content in the source branch and the content in the target branch.

{% include toc.html %}

## Open a Pull Request

Create a branch, and make all the necessary changes in that branch.
When your changes are ready for review, head over to the _Pull Requests_ tab in your repository.
Choose your source branch and target branch, add a title and description (optional, and markdown is supported).

![Open Pull Request]({{ site.baseurl }}/assets/img/pull-request-open.png)

When ready, click _Create Pull Request_. You will be redirected to the newly created pull request page.

## Review Changes

Run validation checks or automated data quality tests to ensure that the changes meet your standards.

![Review Pull Request]({{ site.baseurl }}/assets/img/pull-request-review.png)

Every Pull Request is assigned a unique ID. You can share the Pull Request's URL with others to review the change.

As with any lakeFS reference, reviewers can take the source branch, query, test and modify it as necessary prior to merging.

## Merge or Close

Once the review is complete and all checks have passed, click the _Merge pull request_ button to merge the changes into the target branch.

![Merged Pull Request]({{ site.baseurl }}/assets/img/pull-request-merged.png)

The data is now updated in a controlled and transparent manner.

If the changes are not ready to be merged, you can close the pull request without merging the changes, by clicking the _Close pull request_ button.

## View Pull Requests

You can view all open and closed pull requests in the _Pull Requests_ tab in your repository.
The tabs (_Open_, _Closed_) allow you to filter the list of pull requests according to their status.
Loading