Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an optional metadata section #22

Open
msuchane opened this issue Apr 22, 2021 · 1 comment
Open

Add an optional metadata section #22

msuchane opened this issue Apr 22, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@msuchane
Copy link
Collaborator

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 msuchane added the enhancement New feature or request label Apr 22, 2021
@msuchane msuchane self-assigned this Apr 22, 2021
@jherrman
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants