<html xmlns:v="urn:schemas-microsoft-com:vml" 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:"MS Gothic";
panose-1:2 11 6 9 7 2 5 8 2 4;}
@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;}
@font-face
{font-family:"\@MS Gothic";
panose-1:2 11 6 9 7 2 5 8 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;}
pre
{mso-style-priority:99;
mso-style-link:"HTML Preformatted Char";
margin:0in;
margin-bottom:.0001pt;
font-size:10.0pt;
font-family:"Courier New";}
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.HTMLPreformattedChar
{mso-style-name:"HTML Preformatted Char";
mso-style-priority:99;
mso-style-link:"HTML Preformatted";
font-family:"Courier New";}
p.msonormal0, li.msonormal0, div.msonormal0
{mso-style-name:msonormal;
mso-margin-top-alt:auto;
margin-right:0in;
mso-margin-bottom-alt:auto;
margin-left:0in;
font-size:11.0pt;
font-family:"Calibri",sans-serif;}
span.EmailStyle21
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:windowtext;}
span.EmailStyle22
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:windowtext;}
span.EmailStyle23
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:windowtext;}
span.EmailStyle24
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:#1F497D;}
span.EmailStyle25
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:#1F497D;}
span.EmailStyle26
{mso-style-type:personal;
font-family:"Calibri",sans-serif;
color:windowtext;}
span.EmailStyle27
{mso-style-type:personal-reply;
font-family:"Calibri",sans-serif;
color:#1F497D;}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;}
@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;}
@list l1
{mso-list-id:712580158;
mso-list-type:hybrid;
mso-list-template-ids:1434871310 -1428395444 67698713 67698715 67698703 67698713 67698715 67698703 67698713 67698715;}
@list l1:level1
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:.75in;
text-indent:-.25in;}
@list l1: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 l1: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 l1:level4
{mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:2.25in;
text-indent:-.25in;}
@list l1: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 l1: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 l1:level7
{mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:3.75in;
text-indent:-.25in;}
@list l1: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 l1: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;}
@list l2
{mso-list-id:1073621239;
mso-list-template-ids:-1579022250;}
@list l2:level1
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level2
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level3
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:1.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level4
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:2.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level5
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:2.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level6
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:3.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level7
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:3.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level8
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:4.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l2:level9
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:4.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3
{mso-list-id:1756971922;
mso-list-template-ids:-403277688;}
@list l3:level1
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level2
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level3
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:1.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level4
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:2.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level5
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:2.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level6
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:3.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level7
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:3.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level8
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:4.0in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l3:level9
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:4.5in;
mso-level-number-position:left;
text-indent:-.25in;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="#0563C1" vlink="#954F72">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">I installed Ruby last week and it came out on 10/1 of this year. ¯\_(</span><span style="font-size:11.0pt;font-family:"MS Gothic";color:#1F497D">ツ</span><span style="font-size:11.0pt;color:#1F497D">)_/¯<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">2.7.0 also builds fine--is the c99 stuff new post-release?<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">--Rachel<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"><o:p> </o:p></span></p>
<div>
<div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:11.0pt">From:</span></b><span style="font-size:11.0pt"> archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org <archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org>
<b>On Behalf Of </b>Mayo, Dave<br>
<b>Sent:</b> Thursday, November 7, 2019 10:24 AM<br>
<b>To:</b> ArchivesSpace API Ad Hoc Working Group <archivesspace_api_doc_adhoc@lyralists.lyrasis.org><br>
<b>Subject:</b> Re: [Archivesspace_api_doc_adhoc] Concise "how to build ASpace API Docs" checklist<o:p></o:p></span></p>
</div>
</div>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Nice job! I’ve been flailing at getting a Windows build env for A While, I’m excited that we have at least an example of something that works!<br>
<br>
My guess for the issue with building on master is old versions of headers/etc in your MSYS2 distribution? It looks like it’s failing bc it can’t find some c99 header stuff; depending on when you got Rubyinstaller and what version of MSYS2, it might be before
they had support for c99?<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<div>
<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>
</div>
<p class="MsoNormal"><span style="font-size:11.0pt">Senior Digital Library Software Engineer<br>
Harvard University > HUIT > LTS<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black"><<a href="mailto:archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org">archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org</a>> on behalf of "Donahue, Rachel
- ARS" <<a href="mailto:Rachel.Donahue@usda.gov">Rachel.Donahue@usda.gov</a>><br>
<b>Reply-To: </b>ArchivesSpace API Ad Hoc Working Group <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Date: </b>Monday, November 4, 2019 at 12:39 PM<br>
<b>To: </b>ArchivesSpace API Ad Hoc Working Group <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Subject: </b>Re: [Archivesspace_api_doc_adhoc] Concise "how to build ASpace API Docs" checklist<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
</div>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">An update from Windows land:</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">Maura sent me the two examples files and I installed Node.js—after that, everything worked fine (for 2.6.0, error for building from master attached).</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">I ran all the commands from git bash, which is packaged with this git installer:
</span><a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__git-2Dscm.com_download_win%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3D6aRIPbBr97Zw6wkaPhwa-ObpihQGpCR4XzlSnwOqMrs%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370721970033&sdata=fgjSUM%2FmF19ZZMHGX%2FlUCiA%2BfdxaqE6CFXtHbblNoXg%3D&reserved=0">https://git-scm.com/download/win</a><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">I also always install Ruby with the RubyInstaller, because it’s easy and includes tools to help make Windows behave:
</span><a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__rubyinstaller.org_downloads_%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3DhJg4uAOQVSX-dvi_ycJW4WfQ9s-G8Z-_L-2PTfYaIqY%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370721970033&sdata=piJQkSNh33r%2BGssl1YTJ4358EKDNRMef0OGzWvfSqxo%3D&reserved=0">https://rubyinstaller.org/downloads/</a><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">Make sure you say yes to installing the MSYS2 toolchain.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">I’m currently running Ruby 2.6.5-1</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">--Rachel</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<div>
<div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:11.0pt">From:</span></b><span style="font-size:11.0pt"> Donahue, Rachel - ARS
<br>
<b>Sent:</b> Monday, November 4, 2019 10:07 AM<br>
<b>To:</b> ArchivesSpace API Ad Hoc Working Group <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Subject:</b> RE: [Archivesspace_api_doc_adhoc] Concise "how to build ASpace API Docs" checklist</span><o:p></o:p></p>
</div>
</div>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">Hi all,</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">I tried building ASpace last night from master and kept running into a problem with the sassc gem—not sure why, it would install as a regular gem just fine.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">This morning I was able to build from the v2.6.0 tag, but running
</span><o:p></o:p></p>
<p class="MsoNormal" style="text-indent:.5in"><span style="font-size:11.0pt">build/run backend:test -Dspec='documentation_spec.rb'</span><o:p></o:p></p>
<p class="MsoNormal" style="text-indent:.5in"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">results in “0 examples, 0 failures” which then of course makes doc:build fail due to the lack of an examples file.
</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">Any ideas on how to fix this? I did run the full backend:test before trying just the documentation specfile.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">Alternately, perhaps one of you has a 2.6.0 build and could just share your endpoint_examples.json file?</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D">--Rachel</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt;color:#1F497D"> </span><o:p></o:p></p>
<div>
<div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:11.0pt">From:</span></b><span style="font-size:11.0pt">
<a href="mailto:archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org">archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org</a> <<a href="mailto:archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org">archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org</a>>
<b>On Behalf Of </b>Carbone, Maura<br>
<b>Sent:</b> Thursday, October 31, 2019 9:17 AM<br>
<b>To:</b> ArchivesSpace API Ad Hoc Working Group <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Subject:</b> Re: [Archivesspace_api_doc_adhoc] Concise "how to build ASpace API Docs" checklist</span><o:p></o:p></p>
</div>
</div>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Hello all,</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">I successfully build the docs today (on my mac) and I made a few little changes to Dave’s thing based on my experiences.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">One time:<br>
<br>
1. Set up ArchivesSpace for development</span><o:p></o:p></p>
<p class="MsoNormal" style="margin-left:.75in;text-indent:-.25in;mso-list:l0 level1 lfo3">
<![if !supportLists]><span style="mso-list:Ignore">a.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]><span style="font-size:11.0pt">Clone repository<br>
git clone <a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__gcc02.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-252Fgithub.com-252Farchivesspace-252Farchivesspace.git-26data-3D02-257C01-257C-257Ca805c2f7824d40acabb108d75e0496de-257Ced5b36e701ee4ebc867ee03cfa0d4697-257C0-257C0-257C637081246129609892-26sdata-3DoRosRhjDQZo1Hf-252FF29idlgMuki-252FrJ8EGxkPb898A2t8-253D-26reserved-3D0%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3DBkjVvCAfAYiUAnqUPVchtelOjwET-QFtA8Qmn8H4YKU%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370721980027&sdata=U6%2FmQ9NAx6IhrsqD4710UB0n%2BH0aGWBL%2FFQdiSYEf%2FU%3D&reserved=0">
https://github.com/archivesspace/archivesspace.git</a></span><o:p></o:p></p>
<p class="MsoNormal" style="margin-left:.75in;text-indent:-.25in;mso-list:l0 level1 lfo3">
<![if !supportLists]><span style="mso-list:Ignore">b.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]><span style="font-size:11.0pt">Run following install tasks<br>
build/run bootstrap<br>
build/run db:migrate</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">2. Set up a working “system ruby”, we will install the correct bundler in the next step</span><o:p></o:p></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>
<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</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<pre style="mso-margin-top-alt:3.0pt;margin-right:0in;margin-bottom:3.0pt;margin-left:0in"><span style="font-size:11.0pt">If you encounter the following error:<br></span><span style="font-size:9.0pt;color:#1D1C1D">[java] Cloning into './tech_docs'...<br> [java] Warning: Permanently added the RSA host key for IP address '140.82.114.4' to the list of known hosts.<br> [java] <a href="mailto:git@github.com" target="_blank">git@github.com</a>: Permission denied (publickey).<br> [java] fatal: Could not read from remote repository.</span><o:p></o:p></pre>
<p class="MsoNormal"><span style="font-size:11.0pt">you will need to edit the pull_tech_docs.rb file, found in the scripts directory. In your editor of choice, change the line ‘git_url = “<a href="mailto:git@github.com:archivesspace/tech-docs.git">git@github.com:archivesspace/tech-docs.git</a>”’
to ‘git_url = <a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__gcc02.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-252Fgithub.com-252Farchivesspace-252Ftech-2Ddocs.git-26data-3D02-257C01-257C-257Ca805c2f7824d40acabb108d75e0496de-257Ced5b36e701ee4ebc867ee03cfa0d4697-257C0-257C0-257C637081246129609892-26sdata-3DxdRFgLqFDKvu5y2bd9RQCxjTVTNgN0peJto4m98mkL8-253D-26reserved-3D0%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3DBo3Be2WV5GqyHC8kND6XyVUGxKmlBkTNkA-6doO03hI%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370721990027&sdata=C8vxkPpDKNGNuySytio3R4eckxs4MjHc3mMBDfMPFnY%3D&reserved=0">
https://github.com/archivesspace/tech-docs.git</a>’. Save and then retry build/run doc:build (I am putting in a PR for this change in global since I have heard others encounter this problem)<br>
2. Run the slate build process to generate the final HTML<br>
cd docs/slate/build</span><o:p></o:p></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</span><o:p></o:p></p>
<p class="MsoNormal" style="margin-bottom:12.0pt"><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.
</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black"><<a href="mailto:archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org">archivesspace_api_doc_adhoc-bounces@lyralists.lyrasis.org</a>> on behalf of "Mayo, Dave"
<<a href="mailto:dave_mayo@harvard.edu">dave_mayo@harvard.edu</a>><br>
<b>Reply-To: </b>ArchivesSpace API Ad Hoc Working Group <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Date: </b>Wednesday, October 30, 2019 at 10:30 AM<br>
<b>To: </b>"<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>" <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Subject: </b>Re: [Archivesspace_api_doc_adhoc] Concise "how to build ASpace API Docs" checklist</span><o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
</div>
<p class="MsoNormal"><span style="font-size:11.0pt">Note: as has been pointed out to me, on the line starting 2. Set up a working “system ruby”, the gem install bit there looks like a command line to run – IT IS NOT, I was writing out pseudocode without thinking.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">The correct bundler command is the one below in bullet point 3,<br>
<br>
gem install bundler –version ‘< 2.0’<br>
--</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Dave Mayo (he/him)</span><o:p></o:p></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>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black">"Mayo, Dave" <<a href="mailto:dave_mayo@harvard.edu">dave_mayo@harvard.edu</a>><br>
<b>Date: </b>Tuesday, October 29, 2019 at 3:07 PM<br>
<b>To: </b>"<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>" <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>><br>
<b>Subject: </b>Concise "how to build ASpace API Docs" checklist</span><o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
</div>
<p class="MsoNormal"><span style="font-size:11.0pt">So, the full docs are here: <a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__archivesspace.github.io_archivesspace_user_building-2Dan-2Darchivesspace-2Drelease_%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3DpsMfIOcg_3kzYGcmAdWix7dGYUSsoj4yeyxQ0l92swk%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370721990027&sdata=ZEcRsiRMCtYiyFW%2B3b97i6fKujtBZ2qjl2ERfGn87cc%3D&reserved=0">
https://archivesspace.github.io/archivesspace/user/building-an-archivesspace-release/</a><br>
Docs for the build system: <a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__archivesspace.github.io_archivesspace_user_archivesspace-2Dbuild-2Dsystem_%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3D3qxLeaNhNbJQU3l-FHZRRQ9TNOgn08VjFDYgD2gF5qk%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370722000018&sdata=xyhVomAyMAz6NTxiI06PWpG82di%2BcDpnuEsedJtEYSg%3D&reserved=0">
https://archivesspace.github.io/archivesspace/user/archivesspace-build-system/</a><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</span><o:p></o:p></p>
<p class="MsoNormal" style="margin-left:.75in;text-indent:-.25in;mso-list:l1 level1 lfo6">
<![if !supportLists]><span style="mso-list:Ignore">a.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]><span style="font-size:11.0pt">Clone repository<br>
git clone </span><a href="https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.proofpoint.com%2Fv2%2Furl%3Fu%3Dhttps-3A__gcc02.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-252Fgithub.com-252Farchivesspace-252Farchivesspace.git-26data-3D02-257C01-257C-257Ca805c2f7824d40acabb108d75e0496de-257Ced5b36e701ee4ebc867ee03cfa0d4697-257C0-257C0-257C637081246129619886-26sdata-3DtqyMhudCvLSJsXquOS0IHEwdExLTwEzZ6ohNe78WBzk-253D-26reserved-3D0%26d%3DDwMGaQ%26c%3DWO-RGvefibhHBZq3fL85hQ%26r%3D_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE%26m%3DmpB5LJB3R4GMPlWyg1r41u_Z1xC6kLtspH5OfqLNILA%26s%3D99zcgcWDfqE_wB1lhCwYJooG9-dHbHfqIF3U8QSD7dE%26e%3D&data=02%7C01%7C%7C82209bf522be415e5e1808d76396960a%7Ced5b36e701ee4ebc867ee03cfa0d4697%7C0%7C0%7C637087370722000018&sdata=8CgpNMkCPTcg2%2FPgAouAzjKK5hQqZ5bEhDWns3stFcQ%3D&reserved=0"><span style="font-size:11.0pt">https://github.com/archivesspace/archivesspace.git</span></a><o:p></o:p></p>
<p class="MsoNormal" style="margin-left:.75in;text-indent:-.25in;mso-list:l1 level1 lfo6">
<![if !supportLists]><span style="mso-list:Ignore">b.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]><span style="font-size:11.0pt">Run following install tasks<br>
build/run bootstrap<br>
build/run db:migrate</span><o:p></o:p></p>
<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</span><o:p></o:p></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</span><o:p></o:p></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</span><o:p></o:p></p>
<p class="MsoNormal" style="margin-bottom:12.0pt"><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.</span><o:p></o:p></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.</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">- Dave Mayo<br>
</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">--</span><o:p></o:p></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Dave Mayo (he/him)</span><o:p></o:p></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>
<p class="MsoNormal"><span style="font-size:11.0pt"><br>
<br>
<br>
<br>
This electronic message contains information generated by the USDA solely for the intended recipients. Any unauthorized interception of this message or the use or disclosure of the information it contains may violate the law and subject the violator to civil
or criminal penalties. If you believe you have received this message in error, please notify the sender and delete the email immediately.
<o:p></o:p></span></p>
</div>
</body>
</html>