Documentation metadata: review 'type' metadata
Issue
We have the this section in our style guide: https://docs.gitlab.com/ee/development/documentation/#document-type-metadata
Historically, this type
category was introduced to audit and count the number of pages with these specific types of information. There was also an idea that this metadata could be used for filtering our docs by type.
Problem
- It doesn't quite match our topic types: https://docs.gitlab.com/ee/development/documentation/structure.html
- We're not using this metadata consistently or at all in some cases.
- It's not clear if we use this information for anything useful at the moment.
Usage
These type
metadata items are found in the following amounts in the gitlab repo product docs, across all stage/group page assignments:
-
index
- 40 pages -
concepts
- 53 pages -
howto
- 205 pages -
tutorial
- 9 pages -
reference
- 347 pages
Proposals
Should we:
- Update these types to bring them up to date with our topic types and actively use them going forward?
- Abandon them altogether and scrub this info from the metadata in the docs?
- Something else?
Edited by Craig Norris