chore: organize into folders
This commit is contained in:
1 parent
ca41ea3567
commit
f0b352791c
14 files changed
+24
-24
No files matched your search
@@ -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
|
||||
File renamed without changes.
File renamed without changes.
@@ -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},
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -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}
|
||||
File renamed without changes.
@@ -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
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -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
|
||||
Reference in new issue
Block a user