summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2019-06-18 11:11:58 +0000
committerDouwe Maan <douwe@selenight.nl>2019-06-18 17:35:29 +0200
commit9b3295d34145799abcb659841438a11efb4daafc (patch)
tree53758ca66a07ea319edb42ed36e2c685fa003384
parent3d4f8c7035e88def3e1f78cd880f4b591de9341e (diff)
downloadgitlab-ce-dm-add-deep-dives-to-docs-ce.tar.gz
Add Create Deep Dives to development docsdm-add-deep-dives-to-docs-ce
See https://gitlab.com/gitlab-org/create-stage/issues/1 for more context
-rw-r--r--doc/development/README.md2
-rw-r--r--doc/development/api_graphql_styleguide.md12
-rw-r--r--doc/development/diffs.md11
-rw-r--r--doc/development/elasticsearch.md10
-rw-r--r--doc/development/gitaly.md10
-rw-r--r--doc/development/lfs.md11
-rw-r--r--doc/development/repository_mirroring.md11
7 files changed, 65 insertions, 2 deletions
diff --git a/doc/development/README.md b/doc/development/README.md
index b7322ab731f..9d441884a78 100644
--- a/doc/development/README.md
+++ b/doc/development/README.md
@@ -61,6 +61,8 @@ description: 'Learn how to contribute to GitLab.'
- [How Git object deduplication works in GitLab](git_object_deduplication.md)
- [Geo development](geo.md)
- [Routing](routing.md)
+- [Repository mirroring](repository_mirroring.md)
+- [Git LFS](lfs.md)
## Performance guides
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md
index 38270af682e..f7f36901fe1 100644
--- a/doc/development/api_graphql_styleguide.md
+++ b/doc/development/api_graphql_styleguide.md
@@ -1,5 +1,15 @@
# GraphQL API
+## Deep Dive
+
+In March 2019, Nick Thomas hosted a [Deep Dive] on GitLab's [GraphQL API] 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.9, 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
+[Pull Repository Mirroring functionality]: ../api/graphql/
+[recording on YouTube]: https://www.youtube.com/watch?v=-9L_1MWrjkg
+[Google Slides]: https://docs.google.com/presentation/d/1qOTxpkTdHIp1CRjuTvO-aXg0_rUtzE3ETfLUdnBB5uQ/edit
+[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/8e78ea7f326b2ef649e7d7d569c26d56/GraphQL_Deep_Dive__Create_.pdf
+
## Authentication
Authentication happens through the `GraphqlController`, right now this
@@ -486,4 +496,4 @@ it 'returns a successful response' do
expect(response).to have_gitlab_http_status(:success)
expect(graphql_mutation_response(:merge_request_set_wip)['errors']).to be_empty
end
-```
+``` \ No newline at end of file
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
diff --git a/doc/development/elasticsearch.md b/doc/development/elasticsearch.md
index 8b0f4f02d19..c8c70fa7216 100644
--- a/doc/development/elasticsearch.md
+++ b/doc/development/elasticsearch.md
@@ -4,6 +4,16 @@ This area is to maintain a compendium of useful information when working with el
Information on how to enable ElasticSearch and perform the initial indexing is kept in ../integration/elasticsearch.md#enabling-elasticsearch
+## Deep Dive
+
+In June 2019, Mario de la Ossa hosted a [Deep Dive] on GitLab's [ElasticSearch integration] 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 12.0, 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
+[ElasticSearch integration]: ../integration/elasticsearch.md
+[recording on YouTube]: https://www.youtube.com/watch?v=vrvl-tN2EaA
+[Google Slides]: https://docs.google.com/presentation/d/1H-pCzI_LNrgrL5pJAIQgvLX8Ji0-jIKOg1QeJQzChug/edit
+[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/c5aa32b6b07476fa8b597004899ec538/Elasticsearch_Deep_Dive.pdf
+
## Initial installation on OS X
It is recommended to use the Docker image. After installing docker you can immediately spin up an instance with
diff --git a/doc/development/gitaly.md b/doc/development/gitaly.md
index c8beb808a54..a0585fed2fc 100644
--- a/doc/development/gitaly.md
+++ b/doc/development/gitaly.md
@@ -3,6 +3,16 @@
[Gitaly](https://gitlab.com/gitlab-org/gitaly) is a high-level Git RPC service used by GitLab CE/EE,
Workhorse and GitLab-Shell.
+## Deep Dive
+
+In May 2019, Bob Van Landuyt hosted a [Deep Dive] on GitLab's [Gitaly project] and how to contribute to it as a Ruby developer, 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.11, 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
+[Gitaly project]: https://gitlab.com/gitlab-org/gitaly
+[recording on YouTube]: https://www.youtube.com/watch?v=BmlEWFS8ORo
+[Google Slides]: https://docs.google.com/presentation/d/1VgRbiYih9ODhcPnL8dS0W98EwFYpJ7GXMPpX-1TM6YE/edit
+[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/a4fdb1026278bda5c1c5bb574379cf80/Create_Deep_Dive__Gitaly_for_Create_Ruby_Devs.pdf
+
## Beginner's guide
Start by reading the gitaly repository's
diff --git a/doc/development/lfs.md b/doc/development/lfs.md
new file mode 100644
index 00000000000..8c3408eb6e2
--- /dev/null
+++ b/doc/development/lfs.md
@@ -0,0 +1,11 @@
+# Git LFS
+
+## Deep Dive
+
+In April 2019, Francisco Javier López hosted a [Deep Dive] on GitLab's [Git LFS] implementation 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.10, 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
+[Git LFS]: ../workflow/lfs/manage_large_binaries_with_git_lfs.html
+[recording on YouTube]: https://www.youtube.com/watch?v=Yyxwcksr0Qc
+[Google Slides]: https://docs.google.com/presentation/d/1E-aw6-z0rYd0346YhIWE7E9A65zISL9iIMAOq2zaw9E/edit
+[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/07a89257a140db067bdfb484aecd35e1/Git_LFS_Deep_Dive__Create_.pdf \ No newline at end of file
diff --git a/doc/development/repository_mirroring.md b/doc/development/repository_mirroring.md
new file mode 100644
index 00000000000..f8c33ff2b85
--- /dev/null
+++ b/doc/development/repository_mirroring.md
@@ -0,0 +1,11 @@
+# Repository mirroring
+
+## Deep Dive
+
+In December 2018, Tiago Botelho hosted a [Deep Dive] on GitLab's [Pull Repository Mirroring 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.6, 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
+[Pull Repository Mirroring functionality]: ../workflow/repository_mirroring.md#pulling-from-a-remote-repository-starter
+[recording on YouTube]: https://www.youtube.com/watch?v=sSZq0fpdY-Y
+[Google Slides]: https://docs.google.com/presentation/d/17BTT6M6RyNRckV4wTt-dr07nIfBvD325_xVBoLtSoPM/edit?usp=sharing
+[PDF]: https://gitlab.com/gitlab-org/create-stage/uploads/8693404888a941fd851f8a8ecdec9675/Gitlab_Create_-_Pull_Mirroring_Deep_Dive.pdf \ No newline at end of file