newdoc icon indicating copy to clipboard operation
newdoc copied to clipboard

Add an optional metadata section

Open msuchane opened this issue 4 years ago • 1 comments

Optionally, add a comment block near the start of the generated file that would store certain metadata useful to writers or to Pantheon.

Internal metadata candidates:

  • Supported versions: ex.: 7, 8, 9
  • Last review (by QE): ex.: 7.9, 8.3
  • Tracker ticket, ex. : RHELPLAN-14115, BZ#11265666
  • SMEs
  • User story definition

The exact format of the metadata is up to discussion. It might be useful for the section to be parsable, but it's unclear if the benefit outweighs the cost of maintaining the validity, educating writers, etc.

msuchane avatar Apr 22 '21 11:04 msuchane

Should probably start with a line like e.g. "The following lines contain internal reference information for yourself and other writers. Feel free to adjust or remove as you see fit."

I don't think we should necessarily prepare for machine parseability, given that if/when the feature becomes available, it may likely be through a very different mechanism.

jherrman avatar May 12 '21 11:05 jherrman