[Archivesspace_api_doc_adhoc] Digging in!

Mayo, Dave dave_mayo at harvard.edu
Thu Jan 23 11:32:32 EST 2020 

Yay! Thanks for sharing this.

I remember there being issues around the tech docs repo; but I remember them mostly being permissions issues with pulling it at all; this isn’t something I’ve seen, and it might be worth looking into and reporting.

Good catch on the docs/build -> docs/slate thing, mea culpa – I think I was thinking of the step where you move the built docs over the existing ones, sorry!

--
Dave Mayo (he/him)
Senior Digital Library Software Engineer
Harvard University > HUIT > LTS

From: <archivesspace_api_doc_adhoc-bounces at lyralists.lyrasis.org> on behalf of "David W. Hodges" <dwh2128 at columbia.edu>
Reply-To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" <archivesspace_api_doc_adhoc at lyralists.lyrasis.org>
Date: Tuesday, January 21, 2020 at 9:58 AM
To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" <archivesspace_api_doc_adhoc at lyralists.lyrasis.org>
Subject: Re: [Archivesspace_api_doc_adhoc] Digging in!

Hi all. I finally blocked some time over the weekend to try to get started with this. After spending more time than I'd like to admit getting the doc build process to work, I'm finally good to go. For anyone having problems getting set up (and to remind myself later), I'm documenting what worked for me on Mac OS (10.13), herewith:

  1.  I had the wrong version of Java, but to get Java 8 installed while leaving my later version intact I installed jenv<https://urldefense.proofpoint.com/v2/url?u=http-3A__www.jenv.be_&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=KoJOwk1afAZ__Z2GvQTBeHYTAVHU9S-HyUzZczcBSbg&e=>. This isn't essential but simplifies switching between Java versions for projects.
  2.  Java 8 is seemingly tricky to install as is no longer supported by Oracle. Thankfully there is OpenJDK<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_AdoptOpenJDK_homebrew-2Dopenjdk&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=UYX4bnW-DlKLvPOh1PQrbNvNYJ8SY0EKO8OMQaVNcg0&e=>.
  3.  Initial setup:

     *   git clone https://github.com/archivesspace/archivesspace.git<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_archivesspace_archivesspace.git&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=6rKmmV4GlKN1tzNNkWQeuevEWGPcb4p4ykpclkRYzjI&e=>
     *   cd archivesspace
     *   build/run bootstrap
     *   build/run db:migrate
     *   cd docs/slate/
     *   gem install bundler --version '< 2.0'
     *   bundle install --binstubs
     *   cd ../..
     *   build/run backend:test -Dspec='documentation_spec.rb'

  1.  Building the docs

     *   build/run doc:build

        *   This produced an error:  [java] RuntimeError: unknown file type: ./tech_docs/development/license_agreements/. I'm not sure why this document doesn't exist in the repo, but I was able to bypass the problem by commenting out two lines in scripts/pull_tech_docs.rb that reference license_agreements. Is this a known issue?

     *   cd docs/slate   [This was described as "cd docs/build" in Dave's instructions, but I did not find any "build" directory. Middleman is in "docs/slate/bin" in my install.]
     *   ./bin/middleman build
     *   ./bin/middleman server

        *   (view API at http://localhost:4567<https://urldefense.proofpoint.com/v2/url?u=http-3A__localhost-3A4567&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=mbMMMhJUaO-JdkI_cgvY58M9eIwhEheQmfo_9XZjBME&e=>. If that port is in use, add --port=4568 or other available port.)

Next I'll take a look at the routes and try to assess what I could reasonably work on in the near future.

David

On Thu, Jan 16, 2020 at 9:09 AM Mayo, Dave <dave_mayo at harvard.edu<mailto:dave_mayo at harvard.edu>> wrote:
Lemme know if I can give you a hand – worst case, maybe we can get a virtualbox set up or something like?

Also, at my day job, we’re getting a docker dealie set up specifically for ongoing ASpace dev, I might be able to either yoink it completely, or strip out any Harvard-specific stuff and give it to you, but we’re a ways out from there.

--
Dave Mayo (he/him)
Senior Digital Library Software Engineer
Harvard University > HUIT > LTS

From: <archivesspace_api_doc_adhoc-bounces at lyralists.lyrasis.org<mailto:archivesspace_api_doc_adhoc-bounces at lyralists.lyrasis.org>> on behalf of Rachel Donahue <donahrm at gmail.com<mailto:donahrm at gmail.com>>
Reply-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>>
Date: Wednesday, January 15, 2020 at 9:07 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>>
Subject: Re: [Archivesspace_api_doc_adhoc] Digging in!

Hi Dave (and everyone!),

Sorry for the radio silence here. My snag is that I tried installing from master with Ruby 2.7 and it failed at a different point every time, ha ha ha. (Seriously. I'd specify a local path in a Gemfile and suddenly it would fail three Gemfiles earlier. What they hay, Windows!)

I'm heading out of country through Monday, but Tuesday (1/21) I'll scroll through and figure out which endpoints I've been using the most and claim a few to work on.  I think endpoints related to Agents are likely targets because Resources are pretty well documented, iirc.

-- Rachel
(The same Rachel from USDA, but I'm subscribed here as well since I'll be doing the bulk of the work on my personal desktop. See: Windows shenanigans.)

On Wed, Jan 15, 2020, 1:55 PM Mayo, Dave <dave_mayo at harvard.edu<mailto:dave_mayo at harvard.edu>> wrote:
Hi all,

I hope everyone is doing well – just wanted to call round and see how people were doing.

Last I recall, we’d decided we were going to grab some stuff as it suited us, work on them, and revisit after we got a few in to see if we needed more process.

In that spirit, I’ve grabbed POST /vocabularies – it’s not super-high priority, but it’s potentially something that might be remediable at a lower layer than the individual endpoint, and it’s something I think I can turn around pretty quickly.

Is everyone else well situated to do the same?  I want to reiterate, please reach out to me if you hit any snags, and I think for the first route or so per person, it’d be nice to send an email to the list saying what you did, how it went, etc?

Anyway, thanks y’all!
--
Dave Mayo (he/him)
Senior Digital Library Software Engineer
Harvard University > HUIT > LTS
_______________________________________________
Archivesspace_api_doc_adhoc mailing list
Archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:Archivesspace_api_doc_adhoc at lyralists.lyrasis.org>
http://lyralists.lyrasis.org/mailman/listinfo/archivesspace_api_doc_adhoc<https://urldefense.proofpoint.com/v2/url?u=http-3A__lyralists.lyrasis.org_mailman_listinfo_archivesspace-5Fapi-5Fdoc-5Fadhoc&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=QpIKgLytUa_Xoc51vbIa0WTv4SHnCbd7p4O_LWMakx4&e=>
_______________________________________________
Archivesspace_api_doc_adhoc mailing list
Archivesspace_api_doc_adhoc at lyralists.lyrasis.org<mailto:Archivesspace_api_doc_adhoc at lyralists.lyrasis.org>
http://lyralists.lyrasis.org/mailman/listinfo/archivesspace_api_doc_adhoc<https://urldefense.proofpoint.com/v2/url?u=http-3A__lyralists.lyrasis.org_mailman_listinfo_archivesspace-5Fapi-5Fdoc-5Fadhoc&d=DwMFaQ&c=WO-RGvefibhHBZq3fL85hQ&r=_Mv1dY22K7jvT5MD7xjbvGVzRDOUMhx4WYcnPSIzYnE&m=sYnoeiIyV-qxvNTO9s2nwk51f8DF9u6Q0ouJ-LzIgP4&s=QpIKgLytUa_Xoc51vbIa0WTv4SHnCbd7p4O_LWMakx4&e=>


--
David W. Hodges
Special Collections Analyst
Columbia University Libraries
Butler Library
535 West 114th St.
New York, NY 10027
212 854-8758

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_api_doc_adhoc/attachments/20200123/4d7c52ad/attachment-0001.html>

More information about the Archivesspace_api_doc_adhoc mailing list