search

MarcusBarnes / mik

The Move to Islandora Kit is an extensible PHP command-line tool for converting source content and metadata into packages suitable for importing into Islandora (or other digital repository and preservations systems).
GNU General Public License v3.0
34 stars 10 forks source link

Best place to link to documentation for partial toolchains / single components #372

Open mjordan opened 7 years ago

mjordan commented 7 years ago

The wiki has entries for complete toolchains, but we now have several components that are drop-in replacements for compontents documented as part of existing toolchains. The two components are the new Templated metadata parser and the Islandora OBJ OAI-PMH filegetter. The former is intended for production while the latter is primarily intended for demonstration purposes (although it might prove useful in the future for migrations).

Since these two components can be used with existing toolchains, we'll need to update the wiki entries for those toolchains to mention the components. For example, in the "The METADATA_PARSER section" sections of the CSV and CONTENTdm toolchains' wiki page entries, we'll have to update "Required. Must be 'mods\CsvToMods'".

We also have the "CSV to JSON" toolchain, which is documented on the Information for Developers page. Like the Islandora OBJ OAI-PMH filegetter, this toolchain in intended for demonstration/example purposes only.

My inclination is to add a section that is a sibling of "Toolchains", maybe calling it "Single components and demonstration toolchains". That would cover the miscellaneous stuff but I fear would not be that clear or useful to most end users. Anyone have any other suggestions?

MarcusBarnes commented 7 years ago

Cookbook entries could be another possibility to consider.

mjordan commented 7 years ago

@MarcusBarnes yes that is a good idea, and it would be simple to incorporate links to the cookbook entries from the existing toolchains' wiki entries (see the second paragraph of my original issue, above).

mjordan commented 7 years ago

OK, links to the Cookbook entry on the Templated Metadata Parser and accompanying manipulator are in my latest comment in #373. Once I get the :+1: on those I'll update the CSV and Cdm toolchain pages.

mjordan commented 7 years ago

Ha. Too many issues. I just realized #358 takes care of the Islandora OBJ OAI-PMH Filegetter.