Onboarding Joe to Beyond Translation

[jacobwegner]

@jchill-git and I have started doing some on-boarding for Beyond Translation.

We'll be adding some docs via this PR: https://github.com/scaife-viewer/beyond-translation-site/pull/144

Data formats (initial)

• [ ] Ingest base text
  • https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/library/tlg0012/tlg001/metadata.json
  • https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/library/tlg0012/tlg001/tlg0012.tlg001.perseus-grc2.txt
  • https://beyond-translation.perseus.org/reader/urn:cts:greekLit:tlg0012.tlg001.perseus-grc2:1.1-1.7
• [ ] Ingest translation
  • https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/library/tlg0012/tlg001/metadata.json
  • https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/library/tlg0012/tlg001/metadata.json#L98
  • https://github.com/scaife-viewer/beyond-translation-site/blob/main/backend/data/library/tlg0012/tlg001/tlg0012.tlg001.perseus-eng3.cex
  • https://beyond-translation.perseus.org/reader/urn:cts:greekLit:tlg0012.tlg001.perseus-eng3:1.1-1.130
• [ ] Ingest alignment data
  • Header: https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/annotations/text-alignments/iliad-word-alignment-parrish-998078bc3bab42978b47fa8e8b852cae.json#L2
  • Records: https://github.com/scaife-viewer/beyond-translation-site/blob/ea234d9a352ca869281df7ce606b002e9cb0f742/backend/data/annotations/text-alignments/iliad-word-alignment-parrish-998078bc3bab42978b47fa8e8b852cae.json#L11
  • https://beyond-translation.perseus.org/reader/urn:cts:greekLit:tlg0012.tlg001.perseus-grc2:1.1-1.7?mode=alignments&rs=urn%3Acite2%3Ascaife-viewer%3Aalignment.v1%3Ailiad-word-alignment-parrish-998078bc3bab42978b47fa8e8b852cae
• [ ] Ingest syntax trees
  • TBD, see https://github.com/scaife-viewer/beyond-translation-site/issues/151
• [ ] Ingest token annotations
  • https://github.com/scaife-viewer/beyond-translation-site/tree/main/backend/data/annotations/token-annotations/iliad-crane-shamsian

    https://github.com/scaife-viewer/beyond-translation-site/tree/main/backend/data/annotations/token-annotations/iliad-crane-shamsian

• https://beyond-translation.perseus.org/reader/urn:cts:greekLit:tlg0012.tlg001.perseus-grc2:1.1-1.7?mode=interlinear

Data formats (later)

• [ ] Grammar
• [ ] Named Entities
• ?

[jacobwegner]

We hit a couple of snags with a local env; @jacobwegner will:

• [x] Document "explicit" requirements for Python, Node.js, etc
• [x] Investigate using Codespaces or some other hosted environment (to bypass any unforeseen Conda / Windows issues we may hit)
• [x] Push a few commits to the README files in Beyond Translation to address commands that are out of date or to provide more explicit links to the scaife-viewer/frontend and scaife-viewer/backend repos
• [ ] Set up CI/CD against this branch so @jchill-git can experiment with adding a new data directory

[jacobwegner]

@jchill-git I think Codespaces should work well. I experimented with some things and plan on looping back with you soon!

Codespaces running Beyond Translation and exposing the dev server to the browser:

Frontend dev server:

Backend dev server:

[jchill-git]

@jacobwegner I was able to follow the instructions you added to the documentation last night, and now have Beyond Translation running in Codespaces off of my own fork. Thanks so much!

[jacobwegner]

(Added some notes that @jchill-git and I took today to the issue description; as Joe works through adding new texts / annotations, I'd like to move things from the description into more formal documentation with links to the files he added as a better "breadcrumb" for the next Beyond Translation contributor. Sort of what I did in https://github.com/scaife-viewer/beyond-translation-site/pull/126)