diff options
| author | Douwe Maan <douwe@gitlab.com> | 2019-06-18 14:11:58 +0300 |
|---|---|---|
| committer | Douwe Maan <douwe@selenight.nl> | 2019-06-18 18:35:29 +0300 |
| commit | 9b3295d34145799abcb659841438a11efb4daafc (patch) | |
| tree | 53758ca66a07ea319edb42ed36e2c685fa003384 /doc/development/diffs.md | |
| parent | 3d4f8c7035e88def3e1f78cd880f4b591de9341e (diff) | |
Add Create Deep Dives to development docs
See https://gitlab.com/gitlab-org/create-stage/issues/1 for more context
Diffstat (limited to 'doc/development/diffs.md')
| -rw-r--r-- | doc/development/diffs.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/development/diffs.md b/doc/development/diffs.md index 56e869c21f8..5655398c886 100644 --- a/doc/development/diffs.md +++ b/doc/development/diffs.md @@ -6,6 +6,15 @@ Currently we rely on different sources to present diffs, these include: - Database (through `merge_request_diff_files`) - Redis (cached highlighted diffs) +## Deep Dive + +In Jaunary 2019, Oswaldo Ferreira hosted a [Deep Dive] on GitLab's Diffs and Commenting on Diffs functionality to share his domain specific knowledge with anyone who may work in this part of the code base in the future. You can find the [recording on YouTube], and the slides on [Google Slides] and in [PDF]. Everything covered in this deep dive was accurate as of GitLab 11.7, and while specific details may have changed since then, it should still serve as a good introduction. + +[Deep Dive]: https://gitlab.com/gitlab-org/create-stage/issues/1 +[recording on YouTube]: https://www.youtube.com/watch?v=K6G3gMcFyek +[Google Slides]: https://docs.google.com/presentation/d/1bGutFH2AT3bxOPZuLMGl1ANWHqFnrxwQwjiwAZkF-TU/edit +[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/b5ad2f336e0afcfe0f99db0af0ccc71a/Create_Deep_Dive__Diffs_and_commenting_on_diffs.pdf + ## Architecture overview ### Merge request diffs @@ -124,4 +133,4 @@ File diff will be suppressed (technically different from collapsed, but behaves Diff Viewers, which can be found on `models/diff_viewer/*` are classes used to map metadata about each type of Diff File. It has information whether it's a binary, which partial should be used to render it or which File extensions this class accounts for. -`DiffViewer::Base` validates _blobs_ (old and new versions) content, extension and file type in order to check if it can be rendered. +`DiffViewer::Base` validates _blobs_ (old and new versions) content, extension and file type in order to check if it can be rendered.
\ No newline at end of file |