Skip to content

Split GLFM official spec vs internal extensions

Chad Woolley requested to merge caw-glfm-impl-split-official-vs-extensions into master

What does this MR do and why?

Related: Tracking Issue: Implement GLFM scripts per the ... (#361241)

Splits glfm_canonical_examples.txt into glfm_specification/input/gitlab_flavored_markdown/glfm_official_specification_examples.md and glfm_specification/input/gitlab_flavored_markdown/glfm_internal_extension_examples.md.

These changes have already been documented by Update GLFM docs for official specification vs ... (!98493 - merged): https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#input-specification-files

Tasks:

  • Split files
  • Make associated changes to update-specification.rb script and specs.
  • Update example names in *.yml files to reflect new header names and structure

Note that which examples are contained in which file may change in the future. The point of this MR is simply to put the two files into place for future use.

References

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

How to set up and validate locally

  1. Run scripts/glfm/update-specification.rb and ensure it works (i.e. there should be no changes)

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Chad Woolley

Merge request reports