Documentation of mid-level folder structure and naming conventions

[JenM00re]

Once inside a course folder and the subsequent remediation level folder, there are either two or three subfolders:

• Completed.

• Original.

• Works in Progress. (Optional and only inside of non-vendor course folders.)

  Inside the Completed folder, you can find the following:

• file folders, named according to the <h1> in the html file contained therein.

• Quote# folders, which contain the files remediated within that quote.

• .zip files, which are either the

  1. Quote # files, which can be ignored.
  2. .zipped, remediated files, which can be unpackaged in the repository process.

File folders, named according to the <h1> in the html file contained therein, contain:

• images folder, named "images". (if necessary)
• .html file, named according to the <h1> in the html file.
• .css file (if necessary).

Quote # folders, contain only validator logs, which can be ignored by the repository process.

Inside the Original folder, you can find the following:

• Folders named according to the due dates we've asked vendors to return the files (inside of the vendor folders only).
• .pdf, .docx, .pptx files that may need to be remediated / are being remediated / have been remediated.

For the purpose of the a11ygator repository process, "Original" folders and "Works in Progress" folders can be ignored.