Skip to content

Commit 659b700

Browse files
author
R. S. Doiel
committed
added missing publish_to_s3.bash.1.html
1 parent 89ddb76 commit 659b700

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

‎publish_to_s3.bash.1.html‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>CL-web-components</title>
5+
<link rel="stylesheet" href="/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<nav>
12+
<ul>
13+
<li><a href="/">Home</a></li>
14+
<li><a href="index.html">README</a></li>
15+
<li><a href="LICENSE">LICENSE</a></li>
16+
<li><a href="INSTALL.html">INSTALL</a></li>
17+
<li><a href="user_manual.html">User Manual</a></li>
18+
<li><a href="about.html">About</a></li>
19+
<li><a href="search.html">Search</a></li>
20+
<li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
21+
</ul>
22+
</nav>
23+
<section>
24+
<p>Loading environment from media.env %publish_to_s3.bash(1) user manual
25+
% R. S. Doiel % 2025-08-06</p>
26+
<h1 id="name">NAME</h1>
27+
<p>publish_to_s3.bash</p>
28+
<h1 id="synopsis">SYNOPSIS</h1>
29+
<p>publish_to_s3.bash [OPTION]</p>
30+
<h1 id="description">DESCRIPTION</h1>
31+
<p>publish_to_s3.bash copies the web components and related CSS to the
32+
s3 bucket based on the ENVIRONMENT defined “media.env”.</p>
33+
<h1 id="environment">ENVIRONMENT</h1>
34+
<p>The environment required includes the following</p>
35+
<dl>
36+
<dt>BUCKET_NAME</dt>
37+
<dd>
38+
S3 bucket name, e.g. “s3://media.example.edu”
39+
</dd>
40+
<dt>BASE_URL</dt>
41+
<dd>
42+
The base URL of the website, e.g. “https://media.example.edu”
43+
</dd>
44+
<dt>DISTRIBUTION_ID</dt>
45+
<dd>
46+
The AWS assigned identifier for the bucket. Looks like a long string of
47+
uppercase letters with numbers.
48+
</dd>
49+
</dl>
50+
<h1 id="options">OPTIONS</h1>
51+
<dl>
52+
<dt>help, -h, –help</dt>
53+
<dd>
54+
Display this help page
55+
</dd>
56+
<dt>dry-run, -dry-run, –dry-run</dt>
57+
<dd>
58+
Do a dry run of the copying process without actually copying the
59+
content.
60+
</dd>
61+
</dl>
62+
<h1 id="examples">EXAMPLES</h1>
63+
<pre class="shell"><code>publish_to_s3.bash help
64+
publish_to_s3.bash dry-run
65+
publish_to_s3.bash</code></pre>
66+
</section>
67+
<footer-global></footer-global>
68+
</body>
69+
</html>

0 commit comments

Comments
 (0)