search

Language-Research-Technology / crate-o

Crate-O is a browser-based editor for Research Object Crates (RO-Crate)
https://language-research-technology.github.io/crate-o/
GNU General Public License v3.0
6 stars 2 forks source link

Crate-O Documentation for LDaCA website #123

Closed rosanna-smith closed 3 months ago

rosanna-smith commented 5 months ago

Checklist of items to include (not in specific order):

Reference for summary from Alvin: Mode file: just a json file that can be loaded to crate-o at run time. Can be anywhere but having all of them in one place make things easier to find and load Mode file validator: a library (js code) to validate a mode file. Crate validators: a library that uses various rules (a mode file among others) to validate a crate. Mode file generator: a library to programmatically generate a mode file. Profile generator: a library to generate profile documents

rosanna-smith commented 5 months ago

Any other ones to add at this stage, @ptsefton?

ptsefton commented 5 months ago

also link to or include the explainer on SOSSs

and include SOSS generation/editing in Alvin's list

rosanna-smith commented 4 months ago

@moisbo When the documentation is up it'll be at https://www.ldaca.edu.au/resources/user-guides/crate-o/

moisbo commented 4 months ago

Is this for replacement https://docs.ldaca.edu.au ? because it looks like this is only for crate-o?

rosanna-smith commented 4 months ago

As far as I know, we're not planning on using https://docs.ldaca.edu.au/ for any of the user guide pages. @smusgrav to confirm

moisbo commented 4 months ago

No worries, just because the data.ldaca.edu.au points to there and if you are creating one that is not empty like this one I can quickly update it

rosanna-smith commented 3 months ago

The website now has general information, basic navigation and RO-Crate creation in Crate-O (using a spreadsheet to upload data underway). Would docs on SOSS generation and creating schemas/profiles/modes be better to stay in the relevant repo docs rather than the website? @ptsefton

ptsefton commented 3 months ago

Yep – that detail is for implementers so it should be on those repos I think

--

From: Rosanna @.> Date: Friday, 21 June 2024 at 9:53 am To: Language-Research-Technology/crate-o @.> Cc: Peter Sefton @.>, Mention @.> Subject: Re: [Language-Research-Technology/crate-o] Crate-O Documentation for LDaCA website (Issue #123)

The website now has general information, basic navigation and RO-Crate creation in Crate-O (using a spreadsheet to upload data underway). Would docs on SOSS generation and creating schemas/profiles/modes be better to stay in the relevant repo docs rather than the website? @ptseftonhttps://github.com/ptsefton

— Reply to this email directly, view it on GitHubhttps://github.com/Language-Research-Technology/crate-o/issues/123#issuecomment-2181742044, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAFYTWAPUISCOAJXJPXOOXDZINTQBAVCNFSM6AAAAABGR42NBKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOBRG42DEMBUGQ. You are receiving this because you were mentioned.Message ID: @.***>