FY23Q4 TW OKR: Refactor Helm Charts documentation for better organization => 92%
Many pages in the Administration area include configuration steps for Omnibus and Source installations.
The steps for the GitLab Helm chart are missing. Many configuration options for Helm are on this Globals page. Chart-specific variables might also be required.
This OKR is to update a subset of the Admin pages with instructions for Helm.
Related to: &8595
Implementation details
-
There are 239 pages under Administer GitLab. We need to review these pages and track which ones need Helm instructions. I created a spreadsheet to list the pages that have Omnibus and source steps in them. Looks to be approximately 110 pages. https://docs.google.com/spreadsheets/d/1TmvQJbX096Hk66ohskVD_Xpa4BbCfT5HNYJ72m5wKyA/edit?usp=sharing
-
We need to add tabs as well.
-
Axil will pick the top 10-20 pages and update them accordingly.
Tasks
-
Document standard language for the tabs and the common part of the instructions. gitlab!104163 (merged) -
1 page complete -- tw-weight5 OmniAuth -- gitlab!99159 (merged) -
2 pages complete -- tw-weight5 Issue closing pattern -- gitlab!104384 (merged) -
3 pages complete -- tw-weight8 Generic OAuth 2.0 provider -- gitlab!105729 (merged) -
4 pages complete -- tw-weight8 GitLab Package Registry administration -- gitlab!106421 (merged) -
5 pages complete -- tw-weight8 Integrate LDAP with GitLab -- gitlab!105746 (merged) gitlab!106911 (merged) gitlab!107090 (merged) -
6 pages complete -- tw-weight8 LDAP synchronization -- gitlab!107148 (merged) -
7 pages complete -- tw-weight8 Jobs artifacts administration-- gitlab!108360 (merged) -
8 pages complete -- tw-weight8 Job logs -- gitlab!108360 (merged) gitlab!108794 (merged) -
9 pages complete -- tw-weight8 GitLab Git Large File Storage (LFS) Administration -- gitlab!108803 (merged) -
10 pages complete -- tw-weight13 SAML OmniAuth Provider -- gitlab!108891 (merged) -
11 pages complete -- tw-weight8 Log system -- (we probably need to resolve gitlab#368512) -
12 pages complete -- tw-weight8 Object Storage administration -- gitlab!110387 (merged)