chore: organize into folders

This commit is contained in:
rand committed 2026-09-26 02:06:30 -04:00
1 parent ca41ea3567
commit f0b352791c
14 files changed
+24 -24

No files matched your search

+69
View File
@@ -0,0 +1,69 @@
\chapter{Introduction}
\ChapterLabel{Introduction}
\index{introduction}
\index{DevOps}
\index{scope}
\index{deliverables}
\section{Purpose}
This document records the configuration of the development environment used for
\CourseNumber\ and the working practices followed to produce it. For
Assignment~\AssignmentNumber\ it covers three subjects: the \gls{kanban} that
plans and tracks the assignment work, the hosts the environment will comprise,
and the passwords that will govern accounts on those hosts.
It is a working record rather than a one-time report. Each subsequent
assignment extends it, and the document history records what changed and when,
so that the state of the environment at any point in the term can be recovered
from this document alone.
\section{Scope and Constraints}
\index{scope!constraints}
The following constraints apply to this revision.
\begin{itemize}[leftmargin=*]
\item The environment is \emph{specified} here, not provisioned. The hosts
chapter names the machines to be configured and their intended roles; it
does not claim that any host exists, and it therefore presents no
execution \gls{evidence}.
\item No credential, access token, private key, or account secret appears in
this document. Password rules are documented by derivation hint only, as
described in \ChapterRef{Passwords}.
\item This is an individual submission. Teams have not yet been formalized, so
the board described in \ChapterRef{KanbanSetup} is operated by a single
person and every card is assigned to the author.
\item The document is authored in \LaTeX\ and compiled with pdf\LaTeX\ on
Overleaf. The board is hosted in GitHub Projects. The planned environment
targets Amazon EC2.
\end{itemize}
\section{Deliverables and Due Date}
\begin{tabularx}{\linewidth}{L{3.2cm}Y}
\toprule \textbf{Item} & \textbf{Expectation}\\ \midrule
Due date & \DueDate\\
Instructor & \Instructor\\
Board & GitHub Projects, \texttt{SSW 590} (private; captured as figures in \ChapterRef{KanbanSetup})\\
Required deliverables & Compiled document; Kanban Setup, Passwords, and Hosts chapters; updated document history\\
Team policy & Individual submission pending team formalization\\ \bottomrule
\end{tabularx}
\section{Document Organization}
\index{document organization}
\ChapterRef{KanbanSetup} describes the tool selected for the board, the steps
taken to configure it, the policy governing each column, and the inventory of
cards. \ChapterRef{Hosts} names the hosts to be configured and
their roles. \ChapterRef{Passwords} defines the account and password rules for those hosts. \ChapterRef{AIPromptLog} records AI assistance used in preparing
this document.
This document is derived from the \CourseNumber\ assignment template credited on
the Template Attribution page. The template's instructional example chapter and
its template-maintenance appendices have been removed, since they describe how
to author the template rather than the environment this document records.
\section{Tools and AI Assistance}
\index{AI assistance}
AI assistance was used in preparing this document for drafting, review, and
troubleshooting. It was not used to generate results, command output, or
evidence of work that was not performed. Material assistance is recorded in
\ChapterRef{AIPromptLog} with the task, the inputs supplied, the output used,
and the corrections applied by the author.