<div dir="ltr">Thanks, Brian. That might make sense, but I'll leave it to you to let us know when you're ready for us to submit the tickets. Any idea when that might happen? The goal was to try to get some momentum going on this project, so that the work might come close to completion in the next year. So if we're talking about a few weeks that's fine, but if it's more like a few months then I'd rather have people start submitting tickets earlier to keep things moving.</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, May 21, 2021 at 1:34 PM Brian Hoffman <<a href="mailto:brian.hoffman@lyrasis.org">brian.hoffman@lyrasis.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div lang="EN-US" style="overflow-wrap: break-word;">
<div class="gmail-m_4262903847422751524WordSection1">
<p class="MsoNormal">Hi Trevor,<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">The format of the JIRA example looks good to me. However, perhaps it would make sense to hold off on filing many JIRAs until we have had a chance to improve the automated documentation?<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">Brian<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<div style="border-right:none;border-bottom:none;border-left:none;border-top:1pt solid rgb(181,196,223);padding:3pt 0in 0in">
<p class="MsoNormal" style="margin-bottom:12pt"><b><span style="font-size:12pt;color:black">From:
</span></b><span style="font-size:12pt;color:black">Trevor Thornton <<a href="mailto:trthorn2@ncsu.edu" target="_blank">trthorn2@ncsu.edu</a>><br>
<b>Date: </b>Friday, May 21, 2021 at 12:10 PM<br>
<b>To: </b><a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org" target="_blank">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a> <<a href="mailto:archivesspace_api_doc_adhoc@lyralists.lyrasis.org" target="_blank">archivesspace_api_doc_adhoc@lyralists.lyrasis.org</a>>, Brian Hoffman <<a href="mailto:brian.hoffman@lyrasis.org" target="_blank">brian.hoffman@lyrasis.org</a>>, Lora Woodford <<a href="mailto:Lora.Woodford@lyrasis.org" target="_blank">Lora.Woodford@lyrasis.org</a>><br>
<b>Subject: </b>Re: ArchivesSpace API Documentation Working Group<u></u><u></u></span></p>
</div>
<div>
<p class="MsoNormal">Trying this again.<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Brian and Lora - Please let me know what should be added to or changed with this ticket:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="https://archivesspace.atlassian.net/browse/ANW-1292" target="_blank">https://archivesspace.atlassian.net/browse/ANW-1292</a><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">I'd like to be able to provide an example to the group so we can submit these tickets in a consistent way.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Trevor<u></u><u></u></p>
</div>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<div>
<p class="MsoNormal">On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <<a href="mailto:trthorn2@ncsu.edu" target="_blank">trthorn2@ncsu.edu</a>> wrote:<u></u><u></u></p>
</div>
<blockquote style="border-top:none;border-right:none;border-bottom:none;border-left:1pt solid rgb(204,204,204);padding:0in 0in 0in 6pt;margin-left:4.8pt;margin-right:0in">
<div>
<p class="MsoNormal">Thanks to everybody who was able to join us today to discuss moving forward with improvements to the ArchivesSpace API documentation. The outcomes of today's meeting were:<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">1. API Documentation Working Group members will submit our recommended updates to the API documentation as JIRA tickets (one per endpoint), which the developers, in consultation with the Development Prioritization team, will address in
the course of making other changes in preparation for upcoming releases. This should provide a way for the Working Group and the devs to share the load, with the WG members providing updated documentation without having to go through the process of building,
testing and submitting pull requests, which may have been an inhibitor to progress up to this point.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">2. There are improvements that can be made to the way CURL examples are generated, notably in the use of random strings as placeholder values for URIs. This, and other improvements to the build process for API docs, will be explored by
the development team.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">3. The addition of Python/ArchivesSnake examples requires further discussion. While we want to support the significant number of Python users in the community, there's some concern that this work may be beyond the scope of what the developers
at Lyrasis should take on. To be continued...<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">In the spirit of #1, I submitted a JIRA ticket for an endpoint that has caused me some confusion in the past:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="https://archivesspace.atlassian.net/browse/ANW-1292" target="_blank">https://archivesspace.atlassian.net/browse/ANW-1292</a><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Brian and Lora - Let me know what should be added to or changed with this ticket. I'd like to be able to provide an example to the group so we can submit these tickets in a consistent way.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Please let me know if you have any questions.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Trevor<u></u><u></u></p>
</div>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<div>
<p class="MsoNormal">On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <<a href="mailto:trthorn2@ncsu.edu" target="_blank">trthorn2@ncsu.edu</a>> wrote:<u></u><u></u></p>
</div>
<blockquote style="border-top:none;border-right:none;border-bottom:none;border-left:1pt solid rgb(204,204,204);padding:0in 0in 0in 6pt;margin-left:4.8pt;margin-right:0in">
<div>
<div>
<p class="MsoNormal">This is a gentle reminder to please complete this Doodle poll by the end of the day today if you have not already.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Trevor<u></u><u></u></p>
</div>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<div>
<p class="MsoNormal">On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <<a href="mailto:trthorn2@ncsu.edu" target="_blank">trthorn2@ncsu.edu</a>> wrote:<u></u><u></u></p>
</div>
<blockquote style="border-top:none;border-right:none;border-bottom:none;border-left:1pt solid rgb(204,204,204);padding:0in 0in 0in 6pt;margin-left:4.8pt;margin-right:0in">
<div>
<p class="MsoNormal">Hi Everybody-<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">I'd like to have a meeting to discuss progress on the API Documentation project and some exciting changes that will hopefully move the work forward more quickly.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Preview of the exciting changes: It seems likely that the ArchivesSpace development team at Lyrasis will be able to incorporate updates to the endpoint documentation into their normal course of work, making the necessary updates whenever
they have to do other work on a controller. What they will need from us is to know where there are shortcomings or errors in the existing documentation, as well as Python/ArchivesSnake examples to include in the documentation.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to discuss all of this.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Please complete this Doodle poll to indicate your availability to meet the week of May 10-14:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link" target="_blank">https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link</a><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Please let me know if you have any questions or concerns.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Trevor<br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Trevor Thornton</span><u></u><u></u></p>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Applications Developer, Digital Library Initiatives</span><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">North Carolina State University Libraries</span><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
<p class="MsoNormal"><br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Trevor Thornton</span><u></u><u></u></p>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Applications Developer, Digital Library Initiatives</span><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">North Carolina State University Libraries</span><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
<p class="MsoNormal"><br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Trevor Thornton</span><u></u><u></u></p>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Applications Developer, Digital Library Initiatives</span><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">North Carolina State University Libraries</span><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
<p class="MsoNormal"><br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Trevor Thornton</span><u></u><u></u></p>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">Applications Developer, Digital Library Initiatives</span><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:10pt;color:rgb(102,102,102);background:white">North Carolina State University Libraries</span><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><font size="2" style="background-color:rgb(255,255,255)" color="#666666">Trevor Thornton</font><div><font size="2" style="background-color:rgb(255,255,255)" color="#666666">Applications Developer, Digital Library Initiatives</font></div><div><font size="2" style="background-color:rgb(255,255,255)" color="#666666">North Carolina State University Libraries</font></div></div></div></div></div></div></div>