Tracking Issue: Migrate existing specs Golden Master approach to GLFM Specification approach, and add any additional missing GLFM examples
Overview
TODO: Update the name of this issue to better reflect the scope
This is the single Tracking Issue for the following tasks. Each individual task will only have MRs to represent the work, not separate issues. See the following thread for more discussion on how we arrived at this approach: &7719 (comment 933806489)
See the parent epic for other Tracking Issues: GitLab Flavored Markdown (GLFM) Specification D... (&7719)
See the GLFM Specification Guide development documentation for much more context on all of this work: https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide
Tasks
-
Make final decision on how all files will be named, and how examples from various specifications will be split up across input/output files. Related issues/threads: - Shift GLFM footnote definition to internal exte... (!98381 - merged)
- Consider splitting CommonMark and GFM specs out... (#375300 - closed)
- Update 1: See the following comment for a summary of the current path forward that Brett and Chad have agreed upon: #375300 (comment 1131831270)
- Update 2: This is being implemented in Reorganize GLFM input and output file contents (!101413 - merged)
-
The following goals will be handled as part of ongoing backend and frontend efforts to flesh out the examples in glfm_official_specification.md
andglfm_internal_extensions.md
. For example, as part of Shift GLFM footnote definition to internal exte... (!98381 - merged):- Complete Add missing markdown examples to Markdown Golde... (#345548 - closed)
- Ensure there are appropriate
glfm_example_status.yml
entries for unimplemented/unsupported functionality - Revisit the reorganization and fill out the taxonomy of the specification and examples, in order to complete any additional needed GLFM examples which may be missing from the existing Golden Master approach, and provide full coverage for the complete GLFM official specification and internal extensions.
-
Migrate backend and frontend specs from being driven by the Golden Master Example YML file to instead be driven by new specification-driven "Example Snapshot" YAML files - The plan is to just put everything at the bottom of
glfm_internal_extensions.md
. See discussion thread here: !98381 (comment 1163360637) (on Shift GLFM footnote definition to internal exte... (!98381 - merged)) - MR: Convert GLFM examples from old GM approach (!104933 - merged)
- The plan is to just put everything at the bottom of
-
Delete existing Golden Master spec tests and framework
Edited by Chad Woolley