WIP: Remove antiquated docs
What does this MR do?
This removes several ancient docs that definitely shouldn't be on the docs site.
-
Bookclub: Clearly not product documentation, not touched since added in a docs dump to the docs site in 2016, except to fix links as they break over time.
-
Others: Completely orphaned, not linked to from any page, and not used in any way, essentially no pageviews (likely just automated scans touching the pages from time to time?). Process does not match current process anymore (Job has been gone quite a while now), etc.
In fact, these docs used to be in the handbook a very long time ago, like 2016'ish, before they were moved to the docs site. Redirects were added (check https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/redirects.yml#L466), but they specifically redirect these docs to https://docs.gitlab.com/ee/university/
:
- sources:
- /university/bookclub/
- /university/glossary/
- /university/
- /university/process/
- /university/support/
target: https://docs.gitlab.com/ee/university/
This means that even the redirects are pointing people away from these docs now. Once you hit https://docs.gitlab.com/ee/university/
, you can't click through to these docs (there are no links to them). If the pageviews are increasing, it's likely some automatic scan and not actual users.
I couldn't find any direct links to these docs from www-gitlab-com
either.
Related issues
Related to #20403 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have
developer
access or higher (for example, GitLab team members or Core Team members)-
Apply the documentation label, plus: - The corresponding DevOps stage and group label, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add GitLab's version history note(s). -
Add the product tier badge. -
Add/update the feature flag section. -
If you're changing document headings, search doc/*
,app/views/*
, andee/app/views/*
for old headings replacing with the new ones to avoid broken anchors.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Add Technical Writing and docs::
workflow label. -
Add docs-only when the only files changed are under doc/*
. -
Add twdoing when starting work on the MR. -
Add twfinished after approving and/or merging the MR.
-
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.