redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

WIP: Add a snippet template #177

Closed msuchane closed 2 years ago

msuchane commented 2 years ago

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:

Why add a snippet template:

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.

msuchane commented 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.