<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Calibri",sans-serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:#0563C1;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:#954F72;
text-decoration:underline;}
p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph
{mso-style-priority:34;
margin-top:0in;
margin-right:0in;
margin-bottom:0in;
margin-left:.5in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Calibri",sans-serif;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
/* List Definitions */
@list l0
{mso-list-id:537594637;
mso-list-type:hybrid;
mso-list-template-ids:1434871310 -1428395444 67698713 67698715 67698703 67698713 67698715 67698703 67698713 67698715;}
@list l0:level1
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:.75in;
text-indent:-.25in;}
@list l0:level2
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:1.25in;
text-indent:-.25in;}
@list l0:level3
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
margin-left:1.75in;
text-indent:-9.0pt;}
@list l0:level4
{mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:2.25in;
text-indent:-.25in;}
@list l0:level5
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:2.75in;
text-indent:-.25in;}
@list l0:level6
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
margin-left:3.25in;
text-indent:-9.0pt;}
@list l0:level7
{mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:3.75in;
text-indent:-.25in;}
@list l0:level8
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:4.25in;
text-indent:-.25in;}
@list l0:level9
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
margin-left:4.75in;
text-indent:-9.0pt;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
--></style>
</head>
<body lang="EN-US" link="#0563C1" vlink="#954F72">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt">So, the full docs are here: https://archivesspace.github.io/archivesspace/user/building-an-archivesspace-release/<br>
Docs for the build system: https://archivesspace.github.io/archivesspace/user/archivesspace-build-system/<br>
I’m going to split this into “one-time” and “every time” sections:<br>
This all assumes that “archivesspace” is the root directory of the github checkout, if there’s a cd command, it is relative to this directory<br>
One time:<br>
<br>
1. Set up ArchivesSpace for development<o:p></o:p></span></p>
<ol style="margin-top:0in" start="1" type="a">
<li class="MsoListParagraph" style="margin-left:.25in;mso-list:l0 level1 lfo1"><span style="font-size:11.0pt">Clone repository<br>
git clone <a href="https://github.com/archivesspace/archivesspace.git">https://github.com/archivesspace/archivesspace.git</a><o:p></o:p></span></li><li class="MsoListParagraph" style="margin-left:.25in;mso-list:l0 level1 lfo1"><span style="font-size:11.0pt">Run following install tasks<br>
build/run bootstrap<br>
build/run db:migrate<o:p></o:p></span></li></ol>
<p class="MsoNormal"><span style="font-size:11.0pt">2. Set up a working “system ruby” and gem install bundler “<2.0” I’m not going to go into detail here, but you need to be able to run `bundle install` from a command line<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">3. Set up the slate build environment:
<br>
cd docs/slate<br>
gem install bundler --version '< 2.0'<br>
bundle install –binstubs<br>
4. Generate examples JSON:<br>
build/run backend:test -Dspec='documentation_spec.rb'<br>
Every Time:<br>
<br>
1. Generate the docs (this takes the changes from Endpoints and puts them in the Slate markdown file)<br>
build/run doc:build<br>
2. Run the slate build process to generate the final HTML<br>
cd docs/build<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> ./bin/middleman build # this builds the docs into docs/slate/build<br>
./bin/middleman server # if you want to look at them on localhost:4567<br>
3. To actually change the docs (i.e. to prepare them for submitting in a pull request):<br>
rm -r docs/api<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> mv docs/slate/build docs/api<br>
4. Adding them to git looks like:<br>
git add docs/api docs/slate/source/index.md<br>
git add <whichever files have the endpoints you changed><br>
git commit -m’<message describing docs update>’<br>
<br>
The following steps (7+ in the “how to build a release”) will be handled by project team or whomever merges these changes, I think. Making pull requests will be left till next meeting.<br>
<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">I hope this is helpful, let me know if I missed anything or anything is unclear/insufficiently covered.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">- Dave Mayo<br>
<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">--<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Dave Mayo (he/him)<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Senior Digital Library Software Engineer<br>
Harvard University > HUIT > LTS</span><o:p></o:p></p>
</div>
</body>
</html>