diff --git a/docs/assets/img/pull-request-merged.png b/docs/assets/img/pull-request-merged.png new file mode 100644 index 00000000000..7308e479faa Binary files /dev/null and b/docs/assets/img/pull-request-merged.png differ diff --git a/docs/assets/img/pull-request-open.png b/docs/assets/img/pull-request-open.png new file mode 100644 index 00000000000..4a098d47688 Binary files /dev/null and b/docs/assets/img/pull-request-open.png differ diff --git a/docs/assets/img/pull-request-review.png b/docs/assets/img/pull-request-review.png new file mode 100644 index 00000000000..847fd9c70da Binary files /dev/null and b/docs/assets/img/pull-request-review.png differ diff --git a/docs/howto/index.md b/docs/howto/index.md index d0b42a2476f..b04df99d84b 100644 --- a/docs/howto/index.md +++ b/docs/howto/index.md @@ -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: diff --git a/docs/howto/pull-requests.md b/docs/howto/pull-requests.md new file mode 100644 index 00000000000..533b1aa417b --- /dev/null +++ b/docs/howto/pull-requests.md @@ -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 + +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. \ No newline at end of file