Final (hopefully) changes to the techdoc analysis materials. Director…

…y structure chnages included. Signed-off-by: David Welsch <[email protected]>
cncf · May 31, 2024 · a265fd9 · a265fd9
1 parent c22c52b
commit a265fd9
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 0 deletions.
diff --git a/techdoc-assistance.md → assistance.md b/techdoc-assistance.md → assistance.md
diff --git a/docs/analysis/README.md b/docs/analysis/README.md
@@ -0,0 +1,10 @@
+# TechDoc Analysis
+
+## Contents
+
+This directory contains instructions and criteria for completing a documentation analysis, including a [how-to][] guide and analysis [criteria][].
+
+Templates for the analyses are in the resources directory.
+
+[how-to]: ./howto.md
+[criteria]: ./criteria.md
diff --git a/docs/criteria.md → docs/analysis/criteria.md b/docs/criteria.md → docs/analysis/criteria.md
diff --git a/docs/howto.md → docs/analysis/howto.md b/docs/howto.md → docs/analysis/howto.md
diff --git a/resources/README.md → docs/analysis/resources/README.md b/resources/README.md → docs/analysis/resources/README.md
diff --git a/resources/analysis-template.md → docs/analysis/resources/analysis-template.md b/resources/analysis-template.md → docs/analysis/resources/analysis-template.md
diff --git a/resources/implementation-template.md → ...ysis/resources/implementation-template.md b/resources/implementation-template.md → ...ysis/resources/implementation-template.md
diff --git a/resources/issue-template.md → docs/analysis/resources/issue-template.md b/resources/issue-template.md → docs/analysis/resources/issue-template.md
diff --git a/resources/umbrella-issue-template.md → ...ysis/resources/umbrella-issue-template.md b/resources/umbrella-issue-template.md → ...ysis/resources/umbrella-issue-template.md