@hawkeyexl/manni 3.0.0 → 4.0.0

package/templates/lint/tgdp/tutorial.yaml

@@ -0,0 +1,74 @@
+# Tutorial, derived from The Good Docs Project's tutorial template.
+#
+# Upstream (the authority for every heading below):
+#   https://gitlab.com/tgdp/templates/-/blob/v1.6.0/tutorial/template_tutorial.md
+#   https://gitlab.com/tgdp/templates/-/blob/v1.6.0/tutorial/guide_tutorial.md
+#
+# The upstream Markdown is vendored at test/lint/fixtures/tgdp/template_tutorial.md
+# and linted against this file, so the two cannot drift.
+#
+# What is checked here is structure: which sections a tutorial has, and in what
+# order. Content counts are almost entirely absent on purpose - a tutorial's
+# steps may be a numbered list, a run of subsections, or a mix, and a minimum
+# tuned to the sample page would reject real pages that are perfectly good
+# tutorials.
+#
+# v2: upstream's `# Title` is a placeholder, so there is nothing to say about
+# the page's own heading or content - what used to wrap everything in a
+# `title` section is now the template's own `sections:`.
+info:
+  title: Tutorial (The Good Docs Project)
+  version: "1.6.0"
+  vendor: tgdp
+  pin: v1.6.0
+
+templates:
+  tutorial:
+    types:
+      - tutorial
+    sections:
+      - id: overview
+        heading: Overview
+        max: 1
+        description: >-
+          What the reader will be able to do by the end, who the tutorial
+          is for, and the background knowledge it assumes. The guide calls
+          this the section that decides whether a reader starts at all, so
+          it must say something in prose.
+        contains:
+          paragraphs:
+            min: 1
+      - id: background
+        heading: Background
+        min: 0
+        max: 1
+        description: >-
+          Context the reader needs before starting - what the feature is,
+          or how a supplied starter project is laid out. Upstream marks
+          this section optional in the template body ("{This section is
+          optional.}").
+      - id: before-you-start
+        heading: Before you start
+        max: 1
+        description: >-
+          Prerequisites: prior knowledge, software, environments, access.
+          No content minimum - a prerequisites section that is nothing but
+          a bulleted list is idiomatic.
+      - id: task
+        description: >-
+          One task the tutorial walks the reader through. Upstream heads it
+          with a placeholder (`## {Task name}`), so this rule constrains no
+          heading text. Leaving `max` unbounded is what lets a tutorial be a
+          sequence of these: the placeholder stands for however many the
+          page needs.
+      - id: summary
+        heading: Summary
+        max: 1
+        description: >-
+          The skills and knowledge the reader has gained, stated as
+          outcomes rather than as a repeat of the learning objectives.
+      - id: next-steps
+        heading: Next steps
+        max: 1
+        description: >-
+          Links onward - related tutorials, articles, videos.