[Archivesspace_api_doc_adhoc] ArchivesSpace API Documentation Working Group

[Trevor Thornton]

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>