diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ee404a9e..40946f8f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ If you are reading this document then you are interested in contributing to Isla ## Workflows -The group meets each Wednesday at 1:00 PM Eastern. Meeting notes and announcements are posted to the [Islandora community list](https://groups.google.com/forum/#!forum/islandora) and the [Islandora developers list](https://groups.google.com/forum/#!forum/islandora-dev). You can view meeting agendas, notes, and call-in information [here](https://github.com/Islandora/documentation/wiki#islandora-8-tech-calls). Anybody is welcome to join the calls, and add items to the agenda. +The Islandora 8 Tech Call meets each Wednesday at 1:00 PM Eastern, and the Islandora 8 User Call meets every second Thursday at 1:00 PM Eastern. Meeting notes and announcements are posted to the [Islandora community list](https://groups.google.com/forum/#!forum/islandora) and the [Islandora developers list](https://groups.google.com/forum/#!forum/islandora-dev). You can view meeting agendas, notes, and call-in information [here](https://github.com/Islandora/documentation/wiki#islandora-8-tech-calls). Anybody is welcome to join the calls, and add items to the agenda. ### Use cases diff --git a/docs/contributing/committers.md b/docs/contributing/committers.md index dacedc176..e7a0a0b93 100644 --- a/docs/contributing/committers.md +++ b/docs/contributing/committers.md @@ -1,94 +1,3 @@ # Islandora 8 Committers -Islandora 8 is open source and released under MIT and GPLv2 licenses. The software and associated documentation is developed collectively by a community of contributors and committers. All interested community members are encouraged to contribute to the project. Contributors who demonstrate sustained engagement with the project through quality participation in meetings, mailing lists, documentation and code updates can be nominated by existing committers to also become a committers. It should be emphasized that committers need not be limited to software developers. Community members with skills in documentation and testing, for example, can also be committers. - -## Rights - -Committers share the following rights: - -* Write access to the codebase -* Nomination privileges of new committers -* Release management privileges -* Binding votes on procedural, code modification, and release issues -* Access to the private committers mailing list - -## Responsibilities - -Committers share the following responsibilities: - -* Monitor and respond to project mailing lists -* Attend project and technical meetings -* Monitor and vet bug-tracker issues -* Review and commit code contributions -* Ensure code contributions are properly licensed -* Guide and mentor new committers - -## Committers - -The following is an alphabetized list of the current Islandora 8 committers: - -| Name | Organization | Github username | -|-----------------------------|---------------------------------------|----------------| -| Jonathan Green | LYRASIS | jonathangreen | -| Jonathan Hunt | Catalyst.Net | kayakr | -| Mark Jordan | Simon Fraser University | mjordan | -| Danny Lamb | Islandora Foundation | dannylamb | -| Natkeeran Ledchumykanthan | University of Toronto Scarborough | natkeeran | -| Rosie Le Faive | University of Prince Edward Island | rosiel | -| Seth Shaw | University of Nevada, Las Vegas | seth-shaw-unlv | -| Alan Stanley | University of Prince Edward Islandora | ajstanley | -| Jared Whiklo | University of Manitoba | whikloj | -| Eli Zoller | Arizona State University | elizoller | - -## Emeritus Committers - -The following is an alphabetized list of the prior Islandora 8 committers: - -| Name | Organization | -|-----------------------------|-----------------------------------| -| Aaron Coburn | Amherst College | -| Diego Pino | METRO | -| Nick Ruest | York University | - - -## Guidelines for assessing new candidates for committership - -When a contributor is nominated to become a committer, the following guidelines should be used by existing committers to evaluate the nominee's suitability. - -### Ability to work cooperatively with peers - -How do we evaluate? By the interactions they have through mail. By how they respond to criticism. By how they participate in decision-making process. - -### Ability to be a mentor - -How do we evaluate? By the interactions they have through mail. By how clear they are and how willing they are to point at appropriate background materials (or even create them). - -### Community - -How do we evaluate? By the interactions they have through mail. Do they help to answer questions raised on the mailing list; do they show a helpful attitude and respect for other's ideas. - -### Commitment - -How do we evaluate? By time, by sticking through tough issues, by helping on not-so-fun tasks as well. - -### Personal skill/ability - -How do we evaluate? A solid general understanding of the project. Quality of discussion in mail. Patches (where applicable) easy to apply with only a cursory review. - -## New Committer Process - -This section describes the process for handling the voting of a new committer. - -Summary: - -1. Call a vote ([templates/committerVote.txt](https://raw.githubusercontent.com/Islandora/documentation/master/docs/contributing/templates/committerVote.txt)) -2. Close a vote ([templates/closeCommitterVote.txt](https://raw.githubusercontent.com/Islandora/documentation/master/docs/contributing/templates/closeCommitterVote.txt)) -3. Invite the new committer ([templates/committerInvite.txt](https://raw.githubusercontent.com/Islandora/documentation/master/docs/contributing/templates/committerInvite.txt)), if no CLA is on file ([templates/committerInviteCLA.txt](https://raw.githubusercontent.com/Islandora/documentation/master/docs/contributing/templates/committerInviteCLA.txt)) - -If they accept, then do: - -1. Add to the Islandora 8 Committer team of the Github Islandora organization. -2. Add to Committer team of GitHub Islandora-Labs organization -3. Add to islandora-2x-committers google-group -4. Add to committers wiki page: Islandora 8 Committers (this page) -5. Announce the new committer ([template/committerAnnounce.txt](https://raw.githubusercontent.com/Islandora/documentation/master/docs/contributing/templates/committerAnnounce.txt)) +For information on Islandora Code Committers and Ambassadors, please click [here](https://github.com/Islandora/islandora-community/wiki/Islandora-Code-Committers-and-Ambassadors). diff --git a/docs/contributing/docs_style_guide.md b/docs/contributing/docs_style_guide.md index e810b210b..7e092bd01 100644 --- a/docs/contributing/docs_style_guide.md +++ b/docs/contributing/docs_style_guide.md @@ -10,9 +10,20 @@ - Use `-` instead of `*` for bulleted lists. - Upload images to the 'assets' folder and reference them from there. -- For file name, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu. -- Use `!!! note "Note title"` at the start of a paragraph to have it rendered as a note like this: +- Use the [Admonition syntax](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to create notes like this (four-space indent required): + +_Example:_ + +``` +!!! note "Helpful Tip" + I am a helpful tip! +``` + +_Result:_ + +!!! note "Helpful Tip" + I am a helpful tip! -!!! note "Helpful Tip" I am a helpful tip! ## Don'ts diff --git a/docs/islandora/rdf-mapping.md b/docs/islandora/rdf-mapping.md index ef064feac..124178e41 100644 --- a/docs/islandora/rdf-mapping.md +++ b/docs/islandora/rdf-mapping.md @@ -63,8 +63,28 @@ Below is an example of an RDF mapping as a .yml (YAML) file. It is the current v - The top level key `types` specifies the `rdf:type` of the resource or content model. `field_model`, a required field of Islandora objects, also gets mapped to `rdf:type` through an arcane back-end process. - The top level key `fieldMappings` specifies fields attached to that bundle and their RDF property mappings. One field can be mapped to more than one RDF property. It is a simple flat list. -- `datatype_callback` : [needs documentation] -- `mapping_type: rel` : [needs documentation] + +#### Mapping Types +`mapping_type:`: There are several mapping types which are provided out of the box. +- `rel` - standing for relationship, expresses a relationship between two resources +- `property` - the default, or if a relationship is not provided, expresses the relationship between a resource and some literal text. + +#### Datatype Callbacks +`datatype_callback`: This is a custom function that transforms the output of the field. There are some provided to us by Drupal and some added by Islandora, such as: +- `Drupal\controlled_access_terms\EDTFConverter::dateIso8601Value` which converts dates to Iso format +- `Drupal\jsonld\EntityReferenceConverter::linkFieldPassthrough` which converts a referenced entity to the URI on the entity (which is configurable with the `link_field` argument +An example usage of the `Drupal\jsonld\EntityReferenceConverter::linkFieldPassthrough` is as follows: +```yml +field_subject: + properties: + - 'dcterms:subject' + datatype_callback: + callable: 'Drupal\jsonld\EntityReferenceConverter::linkFieldPassthrough' + arguments: + link_field: 'field_authority_link' +``` +Which would convert a reference to the subject's taxonomy term entity to a reference to the URI provided in `field_authority_link` of that subject's taxonomy term entity. + ## Sample RDF Mapping ```yml