From f0b352791ccd68adda5e28ddc99c33841323c581 Mon Sep 17 00:00:00 2001 From: rand Date: Sat, 26 Sep 2026 02:06:30 -0400 Subject: [PATCH] chore: organize into folders --- .../devopsAIAgentGuide.tex | 22 +++++++++--------- .../devopsAIPromptLog.tex | 0 devopsGlossary.tex => backmatter/glossary.tex | 0 .../devopsDocumentGuide.tex | 4 ++-- .../devopsExampleAssignment.tex | 0 devopsHosts.tex => chapters/devopsHosts.tex | 0 .../devopsIntroduction.tex | 0 .../devopsKanbanSetup.tex | 2 +- .../devopsPasswords.tex | 0 devopsAssignment.tex | 16 ++++++------- kanbanboard.png => figures/kanbanboard.png | Bin abstract.tex => frontmatter/abstract.tex | 0 .../devopsDocumentHistory.tex | 0 prologue.tex => frontmatter/prologue.tex | 4 ++-- 14 files changed, 24 insertions(+), 24 deletions(-) rename devopsAIAgentGuide.tex => backmatter/devopsAIAgentGuide.tex (80%) rename devopsAIPromptLog.tex => backmatter/devopsAIPromptLog.tex (100%) rename devopsGlossary.tex => backmatter/glossary.tex (100%) rename devopsDocumentGuide.tex => chapters/devopsDocumentGuide.tex (97%) rename devopsExampleAssignment.tex => chapters/devopsExampleAssignment.tex (100%) rename devopsHosts.tex => chapters/devopsHosts.tex (100%) rename devopsIntroduction.tex => chapters/devopsIntroduction.tex (100%) rename devopsKanbanSetup.tex => chapters/devopsKanbanSetup.tex (98%) rename devopsPasswords.tex => chapters/devopsPasswords.tex (100%) rename kanbanboard.png => figures/kanbanboard.png (100%) rename abstract.tex => frontmatter/abstract.tex (100%) rename devopsDocumentHistory.tex => frontmatter/devopsDocumentHistory.tex (100%) rename prologue.tex => frontmatter/prologue.tex (88%) diff --git a/devopsAIAgentGuide.tex b/backmatter/devopsAIAgentGuide.tex similarity index 80% rename from devopsAIAgentGuide.tex rename to backmatter/devopsAIAgentGuide.tex index 608fffe..2594004 100644 --- a/devopsAIAgentGuide.tex +++ b/backmatter/devopsAIAgentGuide.tex @@ -23,15 +23,15 @@ approvals, command output, security posture, or operational results. Every assignment chapter shall be stored in exactly one file named with the \texttt{devops} prefix, a PascalCase chapter name, and the \texttt{.tex} suffix. For example, Chapter~2 is fully contained in -\path{devopsExampleAssignment.tex}. A chapter file shall begin with its +\path{chapters/devopsExampleAssignment.tex}. A chapter file shall begin with its \texttt{\string\chapter\{...\}} command and contain all of that chapter's sections and subsections. Do not split one chapter across files, create section-only \texttt{.tex} files, or use \texttt{\string\input} or \texttt{\string\include} to assemble a chapter from smaller fragments. Supporting non-chapter files may use a different name only when they are not -chapter content: \texttt{prologue.tex}, \texttt{abstract.tex}, -\texttt{devopsGlossary.tex}, and \texttt{devopsReferences.bib} are examples. +chapter content: \texttt{frontmatter/prologue.tex}, \texttt{frontmatter/abstract.tex}, +\texttt{backmatter/glossary.tex}, and \texttt{devopsReferences.bib} are examples. Appendix chapters follow the same chapter-file convention. \section{AI Quick Start} @@ -49,12 +49,12 @@ Appendix chapters follow the same chapter-file convention. \begin{tabularx}{\linewidth}{L{4.0cm}Y} \caption{AI Task-Routing Table\label{Table:AITaskRouting}}\\ \toprule \textbf{Task} & \textbf{Minimum authoritative sources}\\ \midrule -Initialize an assignment & \texttt{devopsAssignment.tex}, \texttt{prologue.tex}, \texttt{devopsIntroduction.tex}, \texttt{devopsExampleAssignment.tex}, and the instructor's assignment facts.\\ -Develop a workflow & \texttt{devopsExampleAssignment.tex}, source repository materials, and authorized environment constraints.\\ -Define evidence & \texttt{devopsExampleAssignment.tex} and controlled execution outputs.\\ -Review a retrospective & \texttt{devopsExampleAssignment.tex} and the submitted workflow or runbook.\\ -Edit AI guidance & \texttt{devopsAIAgentGuide.tex}, \texttt{devopsAIPromptLog.tex}, \texttt{devopsDocumentGuide.tex}, and \texttt{devopsAssignment.tex}.\\ -Compile or troubleshoot & \texttt{devopsAssignment.tex}, \texttt{devopsDocumentGuide.tex}, the affected chapter, and the build log.\\ \bottomrule +Initialize an assignment & \texttt{devopsAssignment.tex}, \texttt{frontmatter/prologue.tex}, \texttt{chapters/devopsIntroduction.tex}, \texttt{chapters/devopsExampleAssignment.tex}, and the instructor's assignment facts.\\ +Develop a workflow & \texttt{chapters/devopsExampleAssignment.tex}, source repository materials, and authorized environment constraints.\\ +Define evidence & \texttt{chapters/devopsExampleAssignment.tex} and controlled execution outputs.\\ +Review a retrospective & \texttt{chapters/devopsExampleAssignment.tex} and the submitted workflow or runbook.\\ +Edit AI guidance & \texttt{backmatter/devopsAIAgentGuide.tex}, \texttt{backmatter/devopsAIPromptLog.tex}, \texttt{chapters/devopsDocumentGuide.tex}, and \texttt{devopsAssignment.tex}.\\ +Compile or troubleshoot & \texttt{devopsAssignment.tex}, \texttt{chapters/devopsDocumentGuide.tex}, the affected chapter, and the build log.\\ \bottomrule \end{tabularx} \normalsize @@ -71,7 +71,7 @@ Compile or troubleshoot & \texttt{devopsAssignment.tex}, \texttt{devopsDocumentG \section{Example AI Requests} \subsection{Create an Assignment Brief} \begin{verbatim} -Read devopsAIAgentGuide.tex and use the Initialize an Assignment context. +Read backmatter/devopsAIAgentGuide.tex and use the Initialize an Assignment context. From the supplied SSW 590 objective and constraints, fill only supported placeholders in the introduction and activity brief. Propose clear, observable completion criteria, a safe cleanup action, and a rubric. Do not invent cloud @@ -81,7 +81,7 @@ and report instructor decisions still needed. \subsection{Review a Student Workflow} \begin{verbatim} -Read devopsAIAgentGuide.tex and the workflow, evidence, and retrospective +Read backmatter/devopsAIAgentGuide.tex and the workflow, evidence, and retrospective chapters. Review the supplied repository and sanitized evidence for reproducibility, least privilege, observability, rollback, and cleanup. Separate verified facts from gaps and recommendations. Do not claim that an diff --git a/devopsAIPromptLog.tex b/backmatter/devopsAIPromptLog.tex similarity index 100% rename from devopsAIPromptLog.tex rename to backmatter/devopsAIPromptLog.tex diff --git a/devopsGlossary.tex b/backmatter/glossary.tex similarity index 100% rename from devopsGlossary.tex rename to backmatter/glossary.tex diff --git a/devopsDocumentGuide.tex b/chapters/devopsDocumentGuide.tex similarity index 97% rename from devopsDocumentGuide.tex rename to chapters/devopsDocumentGuide.tex index 328c3be..f2ed29c 100644 --- a/devopsDocumentGuide.tex +++ b/chapters/devopsDocumentGuide.tex @@ -19,7 +19,7 @@ name, and the \texttt{.tex} suffix. Each such file shall contain one complete chapter, beginning with \texttt{\string\chapter\{...\}}, and all of its sections and subsections. Do not split one chapter into section-level \texttt{.tex} files. For example, all of Chapter~2 is contained in -\path{devopsExampleAssignment.tex}. Do not add requirements or +\path{chapters/devopsExampleAssignment.tex}. Do not add requirements or architecture-design chapters; this template records a DevOps learning activity and its operational evidence. @@ -29,7 +29,7 @@ Use one preferred term for each important concept. If an assignment uses equivalent terms, record them here before release. For example, state whether ``continuous delivery'' refers to \gls{cd} generally or specifically excludes automatic production deployment. Add important terms to -\texttt{devopsGlossary.tex} and index them where used. +\texttt{backmatter/glossary.tex} and index them where used. \section{Building the PDF} The template requires a LaTeX distribution with \texttt{pdflatex}, diff --git a/devopsExampleAssignment.tex b/chapters/devopsExampleAssignment.tex similarity index 100% rename from devopsExampleAssignment.tex rename to chapters/devopsExampleAssignment.tex diff --git a/devopsHosts.tex b/chapters/devopsHosts.tex similarity index 100% rename from devopsHosts.tex rename to chapters/devopsHosts.tex diff --git a/devopsIntroduction.tex b/chapters/devopsIntroduction.tex similarity index 100% rename from devopsIntroduction.tex rename to chapters/devopsIntroduction.tex diff --git a/devopsKanbanSetup.tex b/chapters/devopsKanbanSetup.tex similarity index 98% rename from devopsKanbanSetup.tex rename to chapters/devopsKanbanSetup.tex index db621ef..554097e 100644 --- a/devopsKanbanSetup.tex +++ b/chapters/devopsKanbanSetup.tex @@ -88,7 +88,7 @@ especially because this assignment is sequential in places. \index{evidence!Kanban board} \begin{figure}[htbp] \centering -\includegraphics[width=\linewidth]{kanbanboard.png} +\includegraphics[width=\linewidth]{figures/kanbanboard.png} \caption{Kanban board after the assignment cards were added, showing the work-in-progress limit on the \texttt{In progress} column.} \label{Figure:KanbanBoard} diff --git a/devopsPasswords.tex b/chapters/devopsPasswords.tex similarity index 100% rename from devopsPasswords.tex rename to chapters/devopsPasswords.tex diff --git a/devopsAssignment.tex b/devopsAssignment.tex index 38515b0..ef9b449 100644 --- a/devopsAssignment.tex +++ b/devopsAssignment.tex @@ -1,6 +1,6 @@ % SSW 590 DevOps Assignment Template % Developed by Darian Muresan, Ph.D., with OpenAI Codex and Anthropic Claude Code. -% AI agents: read devopsAIAgentGuide.tex before editing this template. +% AI agents: read backmatter/devopsAIAgentGuide.tex before editing this template. \documentclass[12pt]{cornell} \usepackage[T1]{fontenc} @@ -25,7 +25,7 @@ \makeindex \makeglossaries -\input{devopsGlossary.tex} +\input{backmatter/glossary} \definecolor{devopsBlue}{RGB}{31,78,121} \definecolor{devopsGreen}{RGB}{46,125,50} @@ -92,7 +92,7 @@ \begin{document} \pagenumbering{roman} \singlespacing -\include{prologue} +\include{frontmatter/prologue} \setcounter{page}{1} \pagenumbering{arabic} @@ -108,13 +108,13 @@ \renewcommand{\headrulewidth}{0.4pt} \renewcommand{\footrulewidth}{0.4pt} -\include{devopsIntroduction} -\include{devopsKanbanSetup} -\include{devopsHosts} -\include{devopsPasswords} +\include{chapters/devopsIntroduction} +\include{chapters/devopsKanbanSetup} +\include{chapters/devopsHosts} +\include{chapters/devopsPasswords} \appendix -\include{devopsAIPromptLog} +\include{backmatter/devopsAIPromptLog} \printglossaries \cleardoublepage diff --git a/kanbanboard.png b/figures/kanbanboard.png similarity index 100% rename from kanbanboard.png rename to figures/kanbanboard.png diff --git a/abstract.tex b/frontmatter/abstract.tex similarity index 100% rename from abstract.tex rename to frontmatter/abstract.tex diff --git a/devopsDocumentHistory.tex b/frontmatter/devopsDocumentHistory.tex similarity index 100% rename from devopsDocumentHistory.tex rename to frontmatter/devopsDocumentHistory.tex diff --git a/prologue.tex b/frontmatter/prologue.tex similarity index 88% rename from prologue.tex rename to frontmatter/prologue.tex index 1eb112f..77fa869 100644 --- a/prologue.tex +++ b/frontmatter/prologue.tex @@ -18,8 +18,8 @@ This DevOps assignment template was developed by \textbf{Darian Muresan, Ph.D.}, in conjunction with \textbf{OpenAI Codex} and \textbf{Anthropic Claude Code}. \clearpage -\begin{abstract}\input{abstract.tex}\end{abstract} -\input{devopsDocumentHistory.tex} +\begin{abstract}\input{frontmatter/abstract}\end{abstract} +\input{frontmatter/devopsDocumentHistory} \contentspage \tablelistpage \figurelistpage