Closed msuchane closed 2 years ago
We've decided not to make this an official template alongside the four existing ones. The snippet template will only exist in newdoc as an internal file to simplify creating new snippets that comply with the technical requirements.
I'm closing this PR now.
This pull request adds a new template for a text snippet file.
I'm basing the content of the snippet template of several existing sources:
using-text-snippets.adoc
guideline, to explain what a text snippet is and how to use it.Why add a snippet template:
using-text-snippets.adoc
.:_content-type: SNIPPET
attribute for identifying snippet files.I know that snippets have been a controversial and often discussed topic (https://github.com/redhat-documentation/modular-docs/issues/18, https://github.com/redhat-documentation/modular-docs/pull/123, https://github.com/redhat-documentation/modular-docs/pull/161), but given that snippets in our documentation are already a reality and that we've found a compromise in https://github.com/redhat-documentation/modular-docs/issues/18, I think that the template only formalizes what we already have.