= Joint CMDI & Curation taskforces virtual meeting 2018-01-15= ---- * What? * CMDI 1.2 best practices * Who? * Members of the [[Taskforces/CMDI|CMDI]] or the [[Taskforces/Curation|Curation]] taskforces and other people involved/interested in the specification of best practices for CMDI * When? * 15 January 2018, 09.00am - 11.00am CET (on basis of [https://doodle.com/poll/dt8dbrnsagz2nvnz doodle]) * Where? * Zoom: https://clarin.zoom.us/j/829521724 * Note: If using Zoom for the first time, **allow for some setup time before the meeting**. The above link should get you started. See [https://support.zoom.us/hc/en-us/categories/200101697-Getting-Started documentation] for more information. * Add to calendar with details with the meeting's [https://zoom.us/meeting/829521724/ics .ics file] == Documents == - [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/ CMDI Best Pratices draft] on !GitBook - [https://docs.google.com/document/d/1Cr_UqoQFPLt3ucovUuCxne7XVSMZ4awUupev2bTzewc/edit?usp=sharing **OLD** draft CMDI Best Practices doc] on Google Docs - [https://datashare.rzg.mpg.de/s/UGzkBPRQINDtH9Y draft] of CE-2017-1076 (Word) == Preparation == * [all] Look into the [[../BestPracticesEditing|new editing procedure]] * [all] Work on [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/changes change requests] == Agenda == * !GitBook * Discuss workflow (see proposal below) * Share experiences/review editing process * See [[BestPracticesEditing#ExperienceswithGitBook|experiences with GitBook]] * Discuss open [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/discussions comments and discussions] (if any) * Discuss pending changes [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/changes (change requests)] * Planning == Editing workflow proposal == * All editing takes place continuously in well-scoped 'change requests' (see [[../BestPracticesEditing|new editing procedure]]) * For matters that cannot be turned into a change request e.g. because they require further discussion, [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/discussions discussion items] are created * The editors have a regular virtual meeting (e.g with 2-month intervals) to 1. Discuss open [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/discussions discussion items] 1. Review unmerged [https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/changes change requests] 1. Decide on the merging of change requests into the primary version We may also want to use a dedicated [[Slack]] channel (in addition to e-mail) to discuss the best practices in between meetings. == Notes == === !GitBook === * Pros * Integrated editing and publication (variety of output formats including web, pdf, epub) * Option for readers to provide feedback/discussion * Custom theming option * Allows for proper, source-code like versioning and release cycle * Working in fully parallel branches that can be merged at different times * No (real) lock-in, sources are synced with GitHub and are simply markdown * +open source solution * Cons * Support and maintenance not so good * Support: E.g. Alex's auth issue * Maintenance: last commit to official repo last August * And we ran into a few (minor) bugs.... For example diff view can be very slow to load * However: "We've been working on a major new release (beta.gitbook.com), shipping at the end of this month. It includes substantial stability and performance improvements to the editor (and is a much simpler product across the board)." - statement on 2018-01-11) * -> https://beta.gitbook.com/ (we could try it out?) * No simultaneous 'live' editing Google Docs style * We have already hit the user limit in free plan, [https://www.gitbook.com/pricing paid options] not great (10 users - 10 private books for €49/month) * Educational/academic plan? * ~~`TODO`~~ contact to ask about this. * Done (still waiting for reply) * For now create a common account (remove users) * Investigate other options (sphinx-doc, authorea, overleaf, quibb) * ~~`TODO`~~ Twan: prepare template for collaborative comparison * Done: see [https://docs.google.com/spreadsheets/d/1v0FmwYojN4Z_85GbETlIonokXKUXeQJe0tQ-7Rstn2U/edit?usp=sharing document] Change requests * Merged * `#8` CE-2017-1076 (Menzo) * Propagated changes made in published draft * Merged into all change requests * Current * `#6` Fix Modelling... > Workflow > 4. (Hanna) * Complete (see changes), can be merged * `#4` Common approaches: common use cases (Susanne) * Needs to be split up? * `#3` Common approaches: licensing (Twan) * `#2` Common approaches: granularity (Dieter(?)) * `#1` Common approaches: multilingual metadata (Menzo) * `TODO` !Twan/Menzo: recreate change requests, including 'suggestions' from Google doc === Discussions === * https://www.gitbook.com/book/cmdi-taskforce/cmdi-best-practices/discussions/9 * Use component registry, add recommended flag * Task for task force to create a general info component/proifle * Look at existing general info ones * Compare them (e.g. matrix) * Which elements are common? * Which facets do they map to? * Which concepts are used? * Also include usage info? * ~~`TODO`~~ Twan makes a template (probably as a Google Sheet) * Done: see [https://docs.google.com/spreadsheets/d/10JrWFmzc95tszWleaWvgv0bUNRyHWSqKbcFEtIb1kmw/edit?usp=sharing document] * `TODO`: Hanna, Oddrun, Susanne can include components they are familiar with * Wait for recommendation from CCR coordinators: generic or specific concepts * Good/bad examples for concrete bad practices * ~~`TODO`~~ Find output of previous effort to collect (output of schematron evaluation) * [https://docs.google.com/document/d/1yBKzS2mbijaJe3NRBc5xyP88yfn3eI68xVyGNfG3MKA/edit CMDI best practices 'violation' examples] * `TODO`: Output of schematron validation (some aggregated data in the [https://datashare.rzg.mpg.de/s/Djm5mw2gTuR4URN/download CAC presentation]) === Planning === * Next meeting in February: to be decided (Doodle at https://doodle.com/poll/twqyvvk49erb5cw8) * The [[Slack]] channel `#cmdi-best-practices` has been created and all editors have been invited