From a406f5c73bc89c79b12becb1026215ccdbda5bb9 Mon Sep 17 00:00:00 2001
From: R I B Z <kilbergr@users.noreply.github.com>
Date: Wed, 21 Feb 2024 12:25:31 -0800
Subject: [PATCH] adds first draft of bulk download docs

---
 src/templates/cap-docs-page.js | 62 +++++++++++++++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/src/templates/cap-docs-page.js b/src/templates/cap-docs-page.js
index 1aa0745..f9e079f 100644
--- a/src/templates/cap-docs-page.js
+++ b/src/templates/cap-docs-page.js
@@ -52,9 +52,69 @@ export class CapDocsPage extends LitElement {
 						materials included.
 					</p>
 					<h2 class="c-decoratedHeader" id="bulk-downloads">Bulk Downloads</h2>
+					<h3>Downloading</h3>
 					<p>
-						[We will put some documentation content about bulk downloads here.]
+						You can download data manually from the CAP website, or select URLs
+						to download programmatically.
 					</p>
+					<p>
+						To access data, identify the reporter slug and volume number, then visit
+						[URL-TO-COME]/reporter-slug/volume-number.zip. For example, to
+						download the zip for Arkansas Reports (1837-2009), Volume 14, you'd visit
+						[URL-TO-COME]/ark/14.zip. You can identify the reporter slug and volume
+						number by selecting the reporter and volume from the jurisdiction
+						landing page and examining the URL:
+						[URL-TO-COME]/reporter=reporter-slug&volume=volume-number.
+					</p>
+					<p>
+						An alternative way to access downloads is to use <code>wget</code>, which retries
+						when it encounters a network problem. Here's an example for the same zip
+						mentioned above:
+						<pre>wget https://[URL-TO-COME]/ark/14.zip</pre>
+					</p>
+					<h3>Data Format</h3>
+					<p>
+						Bulk data files are provided as zipped directories. In these zips, you
+						will find directories called metadata, json, and html.
+						The metadata directory contains files called VolumeMetadata.json and
+						CasesMetadata.json. The json directory contains all cases for that volume
+						in JSON format. The html directory contains all cases for that volume in
+						HTML format.
+						<pre>.
+├── metadata/
+│   └── VolumeMetadata.json
+│   └── CasesMetadata.json
+├── json/
+│   └── 0001-01.json
+│   └── 0002-01.json
+│   └── etc
+└── html/
+    └── 0001-01.html
+    └── 0003-01.html
+    └── etc
+						</pre>
+					</p>
+					<h3>Using Bulk Data</h3>
+					<p>
+						The .zip file can be unzipped using third-party GUI programs like
+						<a href="https://theunarchiver.com/">The Unarchiver</a> (Mac) or
+						<a href="https://www.7-zip.org/">7-zip</a> (Windows), or from the command
+						line with a command like <code>unzip volume-number.zip</code>.
+						Once you have the directories unzipped, you can interact directly with the
+						files themselves. Alternatively, to read the file from the command line,
+						run (for example):
+						<pre>cat json/0001-01.json | less</pre>
+					</p>
+					<p>
+						If you install <a href="https://stedolan.github.io/jq/download/">jq</a>
+						you can run more sophisticated queries on the json files, such as
+						extracting the id of the case:
+						<pre>cat json/0001-01.json | jq .id | less</pre>
+					</p>
+					<p>
+						You can also interact directly with zipped files via code using libraries
+						such as <a href="https://docs.python.org/3/library/zipfile.html">zipfile</a>
+						with Python.
 				</article>
 			</main>
 			<cap-footer></cap-footer>