Starting moving EE docs to CE
Proposal
Move EE docs in CE, so that there's a single source of truth.
This will be done in conjunction with (or before) the single codebase effort:
- https://about.gitlab.com/handbook/engineering/infrastructure/blueprint/ce-ee-codebases/index.html
- https://about.gitlab.com/handbook/engineering/infrastructure/design/201901_Merging_CE_EE_codebases.html
Why
Having different docs in CE and EE, causes the following problems:
- Merge conflicts in the automatic ce-to-ee merge
- Merge conflicts when you submit an MR to CE (the
ee_compat_check
job will check it) - Additional overhead for the tech writing group having to submit two MRs most of the time (since we add more and more features in EE and conflicts are unavoidable)
- Confusion for contributors and team members where to put the docs (people are contributing to EE for CE features)
Most importantly, people use the "Edit page" link if they want to know the source markdown file in order to make a contribution. That leads them to the EE project and they submit MRs there which in turn means missing docs in CE, as we only merge CE>EE and not vice versa.
List of wrongly submitted MRs:
Here's a list of docs submitted to EE whereas all or parts of them should be in CE:
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1890
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2867
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2892
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2901
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2967
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/3177#note_43900631
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/3852#note_52199834
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/4824
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5597
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6231
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6300
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6312
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6400
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6402
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6431
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6503
- https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6622
Needs
-
Inventory of all /ce docs and see if they differ from /ee -
Add new CI test regarding this change + that docs are being posted only to CE -
Update our fixed MR templates
Next steps
-
Communication with engineering -
Write it down in PROCESS.md