From trthorn2 at ncsu.edu  Thu May  6 09:43:38 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Thu, 6 May 2021 09:43:38 -0400
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
Message-ID: <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>

This is a gentle reminder to please complete this Doodle poll by the end of
the day today if you have not already.

Thanks,
Trevor

On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu> wrote:

> Hi Everybody-
>
> 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.
>
> 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.
>
> Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to
> discuss all of this.
>
> Please complete this Doodle poll to indicate your availability to meet the
> week of May 10-14:
> https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link
>
> Please let me know if you have any questions or concerns.
>
> Thanks,
> Trevor
>
> --
> Trevor Thornton
> Applications Developer, Digital Library Initiatives
> North Carolina State University Libraries
>


-- 
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210506/c5c881dc/attachment.html>

From trthorn2 at ncsu.edu  Fri May  7 09:05:24 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Fri, 07 May 2021 13:05:24 +0000
Subject: [Archivesspace_api_doc_adhoc] Invitation: ArchivesSpace API
 Documentation Working Group @ Fri May 14,
 2021 1pm - 2pm (EDT) (archivesspace_api_doc_adhoc@lyralists.lyrasis.org)
Message-ID: <000000000000c2ca3105c1bd1470@google.com>

You have been invited to the following event.

Title: ArchivesSpace API Documentation Working Group
Let's discuss progress on the API Documentation project and some exciting  
changes that will hopefully&nbsp;move the work forward more quickly.Preview  
of the exciting changes: It seems likely that the  
ArchivesSpace&nbsp;development team at Lyrasis will be able to incorporate  
updates to the endpoint documentation into their normal course of work,  
making the necessary&nbsp;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.Join Zoom  
Meetinghttps://ncsu.zoom.us/j/95565728169?pwd=SXpUamhoTVgzbmhDMlVDUWJIejY3QT09Meeting  
ID: 955 6572 8169Passcode: 995571One tap  
mobile+12678310333,,95565728169#,,,,*995571# US  
(Philadelphia)+13017158592,,95565728169#,,,,*995571# US (Washington DC)Dial  
by your location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 267 831  
0333 US (Philadelphia)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1  
301 715 8592 US (Washington  
DC)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 312 626 6799 US  
(Chicago)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 470 250 9358 US  
(Atlanta)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 470 381 2552 US  
(Atlanta)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 646 518 9805 US  
(New York)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 651 372 8299  
US (Minnesota)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 786 635  
1003 US (Miami)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 929 205  
6099 US (New York)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 206  
337 9723 US (Seattle)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 213  
338 8477 US (Los Angeles)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1  
253 215 8782 US (Tacoma)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1  
346 248 7799 US (Houston)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1  
602 753 0140 US (Phoenix)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1  
669 219 2599 US (San  
Jose)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 669 900 6833 US  
(San Jose)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 720 928 9299  
US (Denver)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+1 971 247 1195  
US (Portland)Meeting ID: 955 6572 8169Passcode: 995571Find your local  
number: https://ncsu.zoom.us/u/aiQUf2c8vJoin by  
SIP95565728169 at zoomcrc.comJoin by H.323162.255.37.11 (US West)162.255.36.11  
(US East)115.114.131.7 (India Mumbai)115.114.115.7 (India  
Hyderabad)213.19.144.110 (Amsterdam Netherlands)213.244.140.110  
(Germany)103.122.166.55 (Australia Sydney)103.122.167.55 (Australia  
Melbourne)149.137.40.110 (Singapore)64.211.144.160 (Brazil)69.174.57.160  
(Canada Toronto)65.39.152.160 (Canada Vancouver)207.226.132.110 (Japan  
Tokyo)149.137.24.110 (Japan Osaka)Meeting ID: 955 6572 8169Passcode: 995571
When: Fri May 14, 2021 1pm ? 2pm Eastern Time - New York
Where:  
https://ncsu.zoom.us/j/95565728169?pwd=SXpUamhoTVgzbmhDMlVDUWJIejY3QT09
Calendar: archivesspace_api_doc_adhoc at lyralists.lyrasis.org
Who:
     * Trevor Thornton - organizer
     * archivesspace_api_doc_adhoc at lyralists.lyrasis.org
     * brian.hoffman at lyrasis.org
     * lora.woodford at lyrasis.org

Event details:  
https://calendar.google.com/calendar/event?action=VIEW&eid=cWUxNzJuNjU0NjQ0MDJzODVlNGIwYWJiM2MgYXJjaGl2ZXNzcGFjZV9hcGlfZG9jX2FkaG9jQGx5cmFsaXN0cy5seXJhc2lzLm9yZw&tok=MTcjdHJ0aG9ybjJAbmNzdS5lZHU2YmZmZjc3MzQ0MmEzNGZjOTVhODU0YThjNzUwM2FhYTQ1ZGY0YTI3&ctz=America%2FNew_York&hl=en&es=0

Invitation from Google Calendar: https://calendar.google.com/calendar/

You are receiving this courtesy email at the account  
archivesspace_api_doc_adhoc at lyralists.lyrasis.org because you are an  
attendee of this event.

To stop receiving future updates for this event, decline this event.  
Alternatively you can sign up for a Google account at  
https://calendar.google.com/calendar/ and control your notification  
settings for your entire calendar.

Forwarding this invitation could allow any recipient to send a response to  
the organizer and be added to the guest list, or invite others regardless  
of their own invitation status, or to modify your RSVP. Learn more at  
https://support.google.com/calendar/answer/37135#forwarding
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210507/c242abd1/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: text/calendar
Size: 5340 bytes
Desc: not available
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210507/c242abd1/attachment-0001.ics>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: invite.ics
Type: application/ics
Size: 5426 bytes
Desc: not available
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210507/c242abd1/attachment-0001.bin>

From trthorn2 at ncsu.edu  Fri May 14 16:57:30 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Fri, 14 May 2021 16:57:30 -0400
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
Message-ID: <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>

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:

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.

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.

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...

In the spirit of #1, I submitted a JIRA ticket for an endpoint that has
caused me some confusion in the past:
https://archivesspace.atlassian.net/browse/ANW-1292

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.

Please let me know if you have any questions.

Thanks,
Trevor

On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu> wrote:

> This is a gentle reminder to please complete this Doodle poll by the end
> of the day today if you have not already.
>
> Thanks,
> Trevor
>
> On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu>
> wrote:
>
>> Hi Everybody-
>>
>> 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.
>>
>> 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.
>>
>> Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us
>> to discuss all of this.
>>
>> Please complete this Doodle poll to indicate your availability to meet
>> the week of May 10-14:
>> https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link
>>
>> Please let me know if you have any questions or concerns.
>>
>> Thanks,
>> Trevor
>>
>> --
>> Trevor Thornton
>> Applications Developer, Digital Library Initiatives
>> North Carolina State University Libraries
>>
>
>
> --
> Trevor Thornton
> Applications Developer, Digital Library Initiatives
> North Carolina State University Libraries
>


-- 
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210514/f458b8ce/attachment.html>

From trthorn2 at ncsu.edu  Fri May 21 12:10:32 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Fri, 21 May 2021 12:10:32 -0400
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
Message-ID: <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>

Trying this again.

Brian and Lora - Please let me know what should be added to or changed with
this ticket:
https://archivesspace.atlassian.net/browse/ANW-1292
I'd like to be able to provide an example to the group so we can submit
these tickets in a consistent way.

Thanks,
Trevor

On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu> wrote:

> 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:
>
> 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.
>
> 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.
>
> 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...
>
> In the spirit of #1, I submitted a JIRA ticket for an endpoint that has
> caused me some confusion in the past:
> https://archivesspace.atlassian.net/browse/ANW-1292
>
> 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.
>
> Please let me know if you have any questions.
>
> Thanks,
> Trevor
>
> On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu> wrote:
>
>> This is a gentle reminder to please complete this Doodle poll by the end
>> of the day today if you have not already.
>>
>> Thanks,
>> Trevor
>>
>> On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu>
>> wrote:
>>
>>> Hi Everybody-
>>>
>>> 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.
>>>
>>> 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.
>>>
>>> Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us
>>> to discuss all of this.
>>>
>>> Please complete this Doodle poll to indicate your availability to meet
>>> the week of May 10-14:
>>> https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link
>>>
>>> Please let me know if you have any questions or concerns.
>>>
>>> Thanks,
>>> Trevor
>>>
>>> --
>>> Trevor Thornton
>>> Applications Developer, Digital Library Initiatives
>>> North Carolina State University Libraries
>>>
>>
>>
>> --
>> Trevor Thornton
>> Applications Developer, Digital Library Initiatives
>> North Carolina State University Libraries
>>
>
>
> --
> Trevor Thornton
> Applications Developer, Digital Library Initiatives
> North Carolina State University Libraries
>


-- 
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/a0fd88ac/attachment.html>

From trthorn2 at ncsu.edu  Fri May 21 13:58:20 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Fri, 21 May 2021 13:58:20 -0400
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
 <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
 <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
Message-ID: <CA+SdyS0H2QOOSqSqvYiqXPPkutE_tCQb=Qbk6PgfsY_7Tepj9g@mail.gmail.com>

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.

On Fri, May 21, 2021 at 1:34 PM Brian Hoffman <brian.hoffman at lyrasis.org>
wrote:

> Hi Trevor,
>
>
>
> 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?
>
>
>
> Brian
>
>
>
> *From: *Trevor Thornton <trthorn2 at ncsu.edu>
> *Date: *Friday, May 21, 2021 at 12:10 PM
> *To: *archivesspace_api_doc_adhoc at lyralists.lyrasis.org <
> archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Brian Hoffman <
> brian.hoffman at lyrasis.org>, Lora Woodford <Lora.Woodford at lyrasis.org>
> *Subject: *Re: ArchivesSpace API Documentation Working Group
>
> Trying this again.
>
>
>
> Brian and Lora - Please let me know what should be added to or changed
> with this ticket:
>
> https://archivesspace.atlassian.net/browse/ANW-1292
>
> I'd like to be able to provide an example to the group so we can submit
> these tickets in a consistent way.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu> wrote:
>
> 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:
>
>
>
> 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.
>
>
>
> 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.
>
>
>
> 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...
>
>
>
> In the spirit of #1, I submitted a JIRA ticket for an endpoint that has
> caused me some confusion in the past:
>
> https://archivesspace.atlassian.net/browse/ANW-1292
>
>
>
> 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.
>
>
>
> Please let me know if you have any questions.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu> wrote:
>
> This is a gentle reminder to please complete this Doodle poll by the end
> of the day today if you have not already.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu>
> wrote:
>
> Hi Everybody-
>
>
>
> 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.
>
>
>
> 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.
>
>
>
> Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to
> discuss all of this.
>
>
>
> Please complete this Doodle poll to indicate your availability to meet the
> week of May 10-14:
>
> https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link
>
>
>
> Please let me know if you have any questions or concerns.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>


-- 
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/c165aefc/attachment-0001.html>

From brian.hoffman at lyrasis.org  Fri May 21 13:34:57 2021
From: brian.hoffman at lyrasis.org (Brian Hoffman)
Date: Fri, 21 May 2021 17:34:57 +0000
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>,
 <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
Message-ID: <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>

Hi Trevor,

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?

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu>
Date: Friday, May 21, 2021 at 12:10 PM
To: archivesspace_api_doc_adhoc at lyralists.lyrasis.org <archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Brian Hoffman <brian.hoffman at lyrasis.org>, Lora Woodford <Lora.Woodford at lyrasis.org>
Subject: Re: ArchivesSpace API Documentation Working Group
Trying this again.

Brian and Lora - Please let me know what should be added to or changed with this ticket:
https://archivesspace.atlassian.net/browse/ANW-1292
I'd like to be able to provide an example to the group so we can submit these tickets in a consistent way.

Thanks,
Trevor

On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
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:

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.

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.

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...

In the spirit of #1, I submitted a JIRA ticket for an endpoint that has caused me some confusion in the past:
https://archivesspace.atlassian.net/browse/ANW-1292

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.

Please let me know if you have any questions.

Thanks,
Trevor

On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
This is a gentle reminder to please complete this Doodle poll by the end of the day today if you have not already.

Thanks,
Trevor

On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
Hi Everybody-

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.

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.

Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to discuss all of this.

Please complete this Doodle poll to indicate your availability to meet the week of May 10-14:
https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link

Please let me know if you have any questions or concerns.

Thanks,
Trevor

--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/69dafeb6/attachment.html>

From brian.hoffman at lyrasis.org  Fri May 21 14:28:35 2021
From: brian.hoffman at lyrasis.org (Brian Hoffman)
Date: Fri, 21 May 2021 18:28:35 +0000
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS0H2QOOSqSqvYiqXPPkutE_tCQb=Qbk6PgfsY_7Tepj9g@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
 <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
 <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>,
 <CA+SdyS0H2QOOSqSqvYiqXPPkutE_tCQb=Qbk6PgfsY_7Tepj9g@mail.gmail.com>
Message-ID: <CY4PR2201MB11582DAFF7EE335D1F4E2B0AFC299@CY4PR2201MB1158.namprd22.prod.outlook.com>

Hi Trevor,

That is a good question. I think it is important that we attend to this and other build / automation issues as soon as we can, so they require less of us in the future. I don?t know exactly when we will be able to get to it, but I hope it can happen this summer. I just made an issue to capture some of the tasks I thought would be required after our meeting last week:

https://archivesspace.atlassian.net/browse/ANW-1298

I don?t want to hold others up though or raise expectations too high, so if your group needs to get started to finish on time I would say don?t wait for us.

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu>
Date: Friday, May 21, 2021 at 1:58 PM
To: Brian Hoffman <brian.hoffman at lyrasis.org>
Cc: archivesspace_api_doc_adhoc at lyralists.lyrasis.org <archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Lora Woodford <Lora.Woodford at lyrasis.org>
Subject: Re: ArchivesSpace API Documentation Working Group
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.

On Fri, May 21, 2021 at 1:34 PM Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>> wrote:
Hi Trevor,

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?

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>>
Date: Friday, May 21, 2021 at 12:10 PM
To: archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org> <archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org>>, Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>>, Lora Woodford <Lora.Woodford at lyrasis.org<mailto:Lora.Woodford at lyrasis.org>>
Subject: Re: ArchivesSpace API Documentation Working Group
Trying this again.

Brian and Lora - Please let me know what should be added to or changed with this ticket:
https://archivesspace.atlassian.net/browse/ANW-1292
I'd like to be able to provide an example to the group so we can submit these tickets in a consistent way.

Thanks,
Trevor

On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
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:

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.

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.

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...

In the spirit of #1, I submitted a JIRA ticket for an endpoint that has caused me some confusion in the past:
https://archivesspace.atlassian.net/browse/ANW-1292

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.

Please let me know if you have any questions.

Thanks,
Trevor

On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
This is a gentle reminder to please complete this Doodle poll by the end of the day today if you have not already.

Thanks,
Trevor

On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
Hi Everybody-

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.

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.

Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to discuss all of this.

Please complete this Doodle poll to indicate your availability to meet the week of May 10-14:
https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link

Please let me know if you have any questions or concerns.

Thanks,
Trevor

--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/e9f0742c/attachment-0001.html>

From trthorn2 at ncsu.edu  Fri May 21 14:45:26 2021
From: trthorn2 at ncsu.edu (Trevor Thornton)
Date: Fri, 21 May 2021 14:45:26 -0400
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CY4PR2201MB11582DAFF7EE335D1F4E2B0AFC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
 <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
 <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
 <CA+SdyS0H2QOOSqSqvYiqXPPkutE_tCQb=Qbk6PgfsY_7Tepj9g@mail.gmail.com>
 <CY4PR2201MB11582DAFF7EE335D1F4E2B0AFC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
Message-ID: <CA+SdyS2s-_d6NLDYeeYkJg0rXrhD_qQNYjOpS_mb0JePoGN1HA@mail.gmail.com>

OK. Why don't we plan to follow up on this in July, and in the meantime the
folks in the Working Group can continue to indicate priorities and make
notes on the spreadsheet.

BTW,  I submitted a separate Jira ticket this week that might belong as
part of your "Upgrade API auto documentation process" issue:
https://archivesspace.atlassian.net/browse/ANW-1294

Thanks for your help with all of this.

On Fri, May 21, 2021 at 2:28 PM Brian Hoffman <brian.hoffman at lyrasis.org>
wrote:

> Hi Trevor,
>
>
>
> That is a good question. I think it is important that we attend to this
> and other build / automation issues as soon as we can, so they require less
> of us in the future. I don?t know exactly when we will be able to get to
> it, but I hope it can happen this summer. I just made an issue to capture
> some of the tasks I thought would be required after our meeting last week:
>
>
>
> https://archivesspace.atlassian.net/browse/ANW-1298
>
>
>
> I don?t want to hold others up though or raise expectations too high, so
> if your group needs to get started to finish on time I would say don?t wait
> for us.
>
>
>
> Brian
>
>
>
> *From: *Trevor Thornton <trthorn2 at ncsu.edu>
> *Date: *Friday, May 21, 2021 at 1:58 PM
> *To: *Brian Hoffman <brian.hoffman at lyrasis.org>
> *Cc: *archivesspace_api_doc_adhoc at lyralists.lyrasis.org <
> archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Lora Woodford <
> Lora.Woodford at lyrasis.org>
> *Subject: *Re: ArchivesSpace API Documentation Working Group
>
> 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.
>
>
>
> On Fri, May 21, 2021 at 1:34 PM Brian Hoffman <brian.hoffman at lyrasis.org>
> wrote:
>
> Hi Trevor,
>
>
>
> 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?
>
>
>
> Brian
>
>
>
> *From: *Trevor Thornton <trthorn2 at ncsu.edu>
> *Date: *Friday, May 21, 2021 at 12:10 PM
> *To: *archivesspace_api_doc_adhoc at lyralists.lyrasis.org <
> archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Brian Hoffman <
> brian.hoffman at lyrasis.org>, Lora Woodford <Lora.Woodford at lyrasis.org>
> *Subject: *Re: ArchivesSpace API Documentation Working Group
>
> Trying this again.
>
>
>
> Brian and Lora - Please let me know what should be added to or changed
> with this ticket:
>
> https://archivesspace.atlassian.net/browse/ANW-1292
>
> I'd like to be able to provide an example to the group so we can submit
> these tickets in a consistent way.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu> wrote:
>
> 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:
>
>
>
> 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.
>
>
>
> 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.
>
>
>
> 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...
>
>
>
> In the spirit of #1, I submitted a JIRA ticket for an endpoint that has
> caused me some confusion in the past:
>
> https://archivesspace.atlassian.net/browse/ANW-1292
>
>
>
> 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.
>
>
>
> Please let me know if you have any questions.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu> wrote:
>
> This is a gentle reminder to please complete this Doodle poll by the end
> of the day today if you have not already.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu>
> wrote:
>
> Hi Everybody-
>
>
>
> 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.
>
>
>
> 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.
>
>
>
> Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to
> discuss all of this.
>
>
>
> Please complete this Doodle poll to indicate your availability to meet the
> week of May 10-14:
>
> https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link
>
>
>
> Please let me know if you have any questions or concerns.
>
>
>
> Thanks,
>
> Trevor
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>
>
>
>
> --
>
> Trevor Thornton
>
> Applications Developer, Digital Library Initiatives
>
> North Carolina State University Libraries
>


-- 
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/eae680fc/attachment.html>

From brian.hoffman at lyrasis.org  Fri May 21 14:48:58 2021
From: brian.hoffman at lyrasis.org (Brian Hoffman)
Date: Fri, 21 May 2021 18:48:58 +0000
Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation
	Working Group
In-Reply-To: <CA+SdyS2s-_d6NLDYeeYkJg0rXrhD_qQNYjOpS_mb0JePoGN1HA@mail.gmail.com>
References: <CA+SdyS3KyCGJSy0743TCLCMB46g64dR91yaoZTsp_VTTA4GnPg@mail.gmail.com>
 <CA+SdyS3yStdQcTbiW1pAGz6G=i7LxLrTWv7EELjv1jD4vru3Sw@mail.gmail.com>
 <CA+SdyS1+8YwZO1EWLYnyapVapF6XV-dh-LeWGkPm2Fq7um9ZGg@mail.gmail.com>
 <CA+SdyS08TGHkQZ5St_K71cF+pyNK6=F4Nm1MTKQa9HTenba6Rg@mail.gmail.com>
 <CY4PR2201MB11584FDA6E1985FDBB75FF51FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>
 <CA+SdyS0H2QOOSqSqvYiqXPPkutE_tCQb=Qbk6PgfsY_7Tepj9g@mail.gmail.com>
 <CY4PR2201MB11582DAFF7EE335D1F4E2B0AFC299@CY4PR2201MB1158.namprd22.prod.outlook.com>,
 <CA+SdyS2s-_d6NLDYeeYkJg0rXrhD_qQNYjOpS_mb0JePoGN1HA@mail.gmail.com>
Message-ID: <CY4PR2201MB115853C7BC54B78D77912997FC299@CY4PR2201MB1158.namprd22.prod.outlook.com>

Thanks Trevor ? I linked the two issues, and please feel free to add stuff to mine if there are points I missed.

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu>
Date: Friday, May 21, 2021 at 2:45 PM
To: Brian Hoffman <brian.hoffman at lyrasis.org>
Cc: archivesspace_api_doc_adhoc at lyralists.lyrasis.org <archivesspace_api_doc_adhoc at lyralists.lyrasis.org>, Lora Woodford <Lora.Woodford at lyrasis.org>
Subject: Re: ArchivesSpace API Documentation Working Group
OK. Why don't we plan to follow up on this in July, and in the meantime the folks in the Working Group can continue to indicate priorities and make notes on the spreadsheet.

BTW,  I submitted a separate Jira ticket this week that might belong as part of your "Upgrade API auto documentation process" issue:
https://archivesspace.atlassian.net/browse/ANW-1294

Thanks for your help with all of this.

On Fri, May 21, 2021 at 2:28 PM Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>> wrote:
Hi Trevor,

That is a good question. I think it is important that we attend to this and other build / automation issues as soon as we can, so they require less of us in the future. I don?t know exactly when we will be able to get to it, but I hope it can happen this summer. I just made an issue to capture some of the tasks I thought would be required after our meeting last week:

https://archivesspace.atlassian.net/browse/ANW-1298

I don?t want to hold others up though or raise expectations too high, so if your group needs to get started to finish on time I would say don?t wait for us.

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>>
Date: Friday, May 21, 2021 at 1:58 PM
To: Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>>
Cc: archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org> <archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org>>, Lora Woodford <Lora.Woodford at lyrasis.org<mailto:Lora.Woodford at lyrasis.org>>
Subject: Re: ArchivesSpace API Documentation Working Group
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.

On Fri, May 21, 2021 at 1:34 PM Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>> wrote:
Hi Trevor,

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?

Brian

From: Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>>
Date: Friday, May 21, 2021 at 12:10 PM
To: archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org> <archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc at lyralists.lyrasis.org>>, Brian Hoffman <brian.hoffman at lyrasis.org<mailto:brian.hoffman at lyrasis.org>>, Lora Woodford <Lora.Woodford at lyrasis.org<mailto:Lora.Woodford at lyrasis.org>>
Subject: Re: ArchivesSpace API Documentation Working Group
Trying this again.

Brian and Lora - Please let me know what should be added to or changed with this ticket:
https://archivesspace.atlassian.net/browse/ANW-1292
I'd like to be able to provide an example to the group so we can submit these tickets in a consistent way.

Thanks,
Trevor

On Fri, May 14, 2021 at 4:57 PM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
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:

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.

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.

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...

In the spirit of #1, I submitted a JIRA ticket for an endpoint that has caused me some confusion in the past:
https://archivesspace.atlassian.net/browse/ANW-1292

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.

Please let me know if you have any questions.

Thanks,
Trevor

On Thu, May 6, 2021 at 9:43 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
This is a gentle reminder to please complete this Doodle poll by the end of the day today if you have not already.

Thanks,
Trevor

On Fri, Apr 30, 2021 at 11:25 AM Trevor Thornton <trthorn2 at ncsu.edu<mailto:trthorn2 at ncsu.edu>> wrote:
Hi Everybody-

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.

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.

Brian Hoffman, the Technical Lead for ArchivesSpace, will be joining us to discuss all of this.

Please complete this Doodle poll to indicate your availability to meet the week of May 10-14:
https://doodle.com/poll/eu7iddd7ndug9sz5?utm_source=poll&utm_medium=link

Please let me know if you have any questions or concerns.

Thanks,
Trevor

--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries


--
Trevor Thornton
Applications Developer, Digital Library Initiatives
North Carolina State University Libraries
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20210521/117642f7/attachment-0001.html>