Documentation Sprint 1.1.0 - Google Sheets JavaScript isn't enabled in your browser, so this file can't be opened. Enable and reload. Documentation Sprint 1.1.0          Share Sign in The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss File Edit View Insert Format Data Tools Form Add-ons Help Accessibility Unsaved changes to Drive See new changes                 $ %     123                             Conditional formatting     Conditional formatting                                                                                                   SUM AVERAGE COUNT MAX MIN Learn more                     Accessibility               A B C D E F G H I J K L M N O P Q R S T U V W X Y Z AA AB AC AD 1 Review Complete Auditor Reviewer Link Status Type Audience Goal PROBLEMS NOTES 2 About https://islandora.github.io/documentation/ Good For Now Conceptual Stranger Explains at a high level what islandora does 3 Concepts Structuring menu item - not a page 4 Reviewed DIG MA ├── Collections https://islandora.github.io/documentation/concepts/collection/ Needs Work Conceptual Newcomer Explain the concept of Collections in Islandora, with reference to bulk management and the interaction of Islandora Defaults. Points to page that does not exist yet (Bulk Editing). Assumes some Basic Drupal knowledge and knowledge of Islandora Defaults, too early (because this is one of the first pages in the documentation). Collections should probably not be the first page in the documentation tree. 'Content Types' should be in the Glossary. Add more links. 5 Audited MH ├── Access Control https://islandora.github.io/documentation/concepts/access-control/ Needs Work Conceptual DevOps, repository manager Explain what mechanism(s) for access control are available and how restrictions affect Islandora repo content Mixes documentation type and audiences; make this conceptual documentation for repository managers that explains which levels of restriction can be configured, how inheritance works (it doesn't), separate out sysadmin/devops documentation about preventing access to other components of the stack, consider moving overview over contrib modules not part of Islandora core/default to a "solution gallery" or cookbook section with recommendations; fix link to documentation page on manging user accounts 6 KC ├── Accessibility https://islandora.github.io/documentation/concepts/accessibility/ Conceptual 7 ├── Component Overview https://islandora.github.io/documentation/installation/component_overview/ Conceptual Stranger Give an understanding of what components Islandora include and how they work together. This should have a link to the architecture diagram: https://islandora.github.io/documentation/technical-documentation/diagram/ (MA) 8 AB ├── Modelling content in Islandora 8 vs. 7 https://islandora.github.io/documentation/user-documentation/objects_to_resource_nodes/ Conceptual Islandora 7 user Translate between the "object" and "datastreams" model and the "nodes" and "media" model 9 └── Islandora Defaults https://islandora.github.io/documentation/reference/islandora_defaults_reference/ Conceptual Create sensible expectations around configurability and ongoing support 10 Installation Structuring menu item - not a page Proposed page under this menu item: Installation overview, describing why we have so many installation methods 11 ├── Docker Compose (ISLE-DC) https://islandora.github.io/documentation/installation/docker-compose/ Conceptual Reference page: what is ISLE. Explain "best practices" like Remov tutorial Proposed sub-page: Tutorial Create a Dev-Environment; procedural; geared towards 'baby devs'; Hand-hold walkthrough of creating a local sandbox 12 ├── Ansible Playbook https://islandora.github.io/documentation/installation/playbook/ Needs Work Procedural 13 ├── Manual Installation Structuring menu item - not a page Procedural 14 │ ├── Introduction https://islandora.github.io/documentation/installation/manual/introduction/ Procedural Site Builder Assumes, but does not specify Ubuntu (or similar) operating system 15 CG │ ├── Preparing a LAPP Webserver https://islandora.github.io/documentation/installation/manual/preparing_a_webserver/ Needs Work Procedural Site Builder Remove jargon, check specifications. Is this locked to PHP 7.2? To PostgreSQL? LAPP? Linux Apache PostgreSQL & PHP? 16 │ ├── Installing Composer, Drush, and Drupal https://islandora.github.io/documentation/installation/manual/installing_composer_drush_and_drupal/ Procedural Site Builder 17 │ ├── Installing Tomcat and Cantaloupe https://islandora.github.io/documentation/installation/manual/installing_tomcat_and_cantaloupe/ Procedural Site Builder 18 │ ├── Installing Fedora, Syn, and Blazegraph https://islandora.github.io/documentation/installation/manual/installing_fedora_syn_and_blazegraph/ Procedural Site Builder 19 │ ├── Installing Solr https://islandora.github.io/documentation/installation/manual/installing_solr/ Procedural Site Builder 20 │ ├── Installing Crayfish https://islandora.github.io/documentation/installation/manual/installing_crayfish/ Procedural Site Builder 21 │ ├── Installing Karaf and Alpaca https://islandora.github.io/documentation/installation/manual/installing_karaf_and_alpaca/ Procedural Site Builder 22 │ └── Configuring Drupal https://islandora.github.io/documentation/installation/manual/configuring_drupal/ Procedural Site Builder 23 └── Installing Modules https://islandora.github.io/documentation/technical-documentation/install-enable-drupal-modules/ Procedural Site Builder 24 Tutorials Structuring menu item - not a page 25 Reviewed MC MAC ├── Create a Resource Node https://islandora.github.io/documentation/tutorials/create-a-resource-node/ Good For Now Procedural Islandora/Drupal Novice, Content/Collection Manager Hand holdy walkthrough of creating a resource node with a media file. Note in tutorial to Keep it simple and avoid fields with the autocomplete symbol could stand an explanation for avoiding, or a link to more information elsewhere. 26 Audited MC KC ├── Create a Collection https://islandora.github.io/documentation/tutorials/how-to-create-collection/ Good For Now Procedural Islandora/Drupal Novice, Content/Collection Manager Walkthrough of creating and populating a Collection in UI Minor accuracy issue: References to "Collection Members" tab should be changed to "Children tab" as shown in screenshots. This tutorial has "Introduction" section, while previous tutorial has opening "Overview" section 27 Audited MC ├── Configure Blocks https://islandora.github.io/documentation/tutorials/blocks/ Needs Work Procedural Islandora/Drupal Novice, Site Builder Walkthrough of general Block layout and Context configurations Lack of labeled "Overview" or "Introduction" section. Screenshots and steps in the Using Context section need to be updated to match current release (as seen on public sandbox). For example, Context list page on sandbox shows more context groupings than screenshot; text for "Click 'Configure' button" step should read "click 'Edit' option" I found myself wondering if there are Islandora-specific blocks of interest, or if the majority of Islandora-centric configurations are in the Context options (which seems to be the case). 28 Reviewed MC MAC ├── Create or Update a View https://islandora.github.io/documentation/tutorials/create_update_views/ Needs Work Procedural Islandora/Drupal Novice, Site Builder Walkthrough of how to modify existing and create new views Screenshot for step 4.a doesn't match sandbox (different button name). In Create new view section, instructions include selecting "Create a block." Some explanation of relationship with blocks as they are explained in separate page would be helpful. 29 Audited MC └── Video Documentation https://islandora.github.io/documentation/user-documentation/video-docs/ Needs Work Reference Islandora/Drupal Novice, consumers of documentation in video format Provide browsable list of video tutorials available, organized by broad categories Lacks Intro/Overview section in TOC, even though there is intro text. Link to "the playlist" is a link to this page (self-referencing, instead of linking out to YouTube playlist). Text for "Regenerating a Derivative" video link has a typo. The intro text mentions that new videos are added to the playlist (and updated here on this page?) regularly, so it would be nice to place the page's last update info at the top rather than in the footer as it is currently. 30 Documentation Structuring menu item - not a page 31 ├── Introduction https://islandora.github.io/documentation/user-documentation/user-intro/ Conceptual 32 AB KC ├── Intro to Linked Data https://islandora.github.io/documentation/user-documentation/intro-to-ld-for-islandora-8/ Conceptual 33 Audited MA ├── Versioning https://islandora.github.io/documentation/user-documentation/versioning/ Needs Work Conceptual Islandora/Drupal Novice, Site Builder Describes how versioning works in Islandora and Fedora+Islandora, including the workflow Specifically references Islandora 8.x-1.1. This should be updated or made evergreen. This page could also be a good place to intoduce/explain semantic versioning? 34 ├── Content in Islandora 8 Structuring menu item - not a page Conceptual 35 Reviewed MC MA │ ├── Resource Nodes https://islandora.github.io/documentation/user-documentation/resource-nodes/ Conceptual Islandora/Drupal Novice, Repository admins Provide detailed explanation of the components and configuration options for resource nodes. Lacks Intro/Overview section in TOC, even though there is intro text. Last update date at top of page doesn't match last update date in footer. Islandora 8 Property/Value table is missing a row for uid. Field section could use expansion covering how to view/manage/configure fields, to be more consistent with other sections on page. Display modes section needs more clarity in last paragraph about order and overrides. Adding links between this page and the Create a Resource page at https://islandora.github.io/documentation/tutorials/create-a-resource-node/ would be helpful. 36 MC │ ├── Media https://islandora.github.io/documentation/user-documentation/media/ Conceptual 37 MC │ ├── Paged Content https://islandora.github.io/documentation/user-documentation/paged-content/ Conceptual 38 MR │ └── Metadata https://islandora.github.io/documentation/user-documentation/metadata/ Good For Now Conceptual Systems Admin, Users, Novice To describe the basic metadata configuration, how it's stored, and ways it can be configured One minor note is that I was a bit confused by the paragraph that began with "Not all content types in your Drupal site need be Islandora "resource nodes"." It took me two reads to grasp what they were talking about. 39 ├── Configuring Islandora Structuring menu item - not a page Procedural 40 AB │ ├── Modify or Create a Content Type https://islandora.github.io/documentation/user-documentation/content_types/ Procedural 41 │ ├── Configure Search https://islandora.github.io/documentation/user-documentation/searching/ Procedural 42 RL │ ├── Configure Context https://islandora.github.io/documentation/user-documentation/context/ Procedural 43 MR MC │ ├── Multilingual https://islandora.github.io/documentation/user-documentation/multilingual/ Procedural 44 Audited MA │ ├── Extending Islandora https://islandora.github.io/documentation/user-documentation/extending/ Good For Now Reference Site builders To describe an dlink to additional resources for adding non-Islandora Drupal modules. Mostly pointing to the Cookbook. Very brief, just pointing out. Could be imporved by adding https://www.drupal.org/project/project_theme as a link when mentioning themes. 45 Audited MA │ ├── Viewers https://islandora.github.io/documentation/user-documentation/file_viewers/ Needs Work Conceptual Site builders Explains how viewers work, including a configuration example Attempts to be procedural, but the example is not quite written step-by-step enough to follow along and accomplish a goal. Audience seems to be Site builders, especially based on context of the other pages in this section, but it's written a little technical. 46 MA │ ├── IIIF https://islandora.github.io/documentation/user-documentation/iiif/ Reference Site builders Explains what IIIF is and how it works in tghe Islandora context. Crosses the line between procedural and reference, since it both explains, and has some steps for making changes 47 MR │ ├── OAI-PMH https://islandora.github.io/documentation/user-documentation/oai/ Procedural 48 MR │ ├── RDF Generation https://islandora.github.io/documentation/islandora/rdf-mapping/ Procedural 49 MR │ ├── Drupal Bundle Configurations https://islandora.github.io/documentation/islandora/drupal-bundle-configurations/ Procedural 50 │ └── Flysystem https://islandora.github.io/documentation/technical-documentation/flysystem/ Procedural 51 └── Operating an Islandora Repository Structuring menu item - not a page Procedural 52 MC . ├── Create and Manage User Accounts https://islandora.github.io/documentation/user-documentation/users/ Procedural 53 . └── Usage Stats https://islandora.github.io/documentation/user-documentation/usage-stats/ Procedural 54 System Administrator Documentation Structuring menu item - not a page 55 Reviewed MH MA ├── Updating Drupal https://islandora.github.io/documentation/technical-documentation/updating_drupal/ Needs Work Procedural system administrator explain steps needed to update the Drupal component of the Islandora stack check if described process reflects the approach necessary for ISLE; page says it's missing description on updating Islandora features; 'make backup' admonition should be step in the process; 'alternate syntax needed' admonition should be step in the process; highlight more explicitly if Islandora pins versions of Drupal components or modules Missing pages: Describe how to update any other component of the stack that requires special instructions 56 Audited MH RL ├── Uploading large files https://islandora.github.io/documentation/technical-documentation/uploading-large-files/ Good For Now Reference system administrator explain configuration options for use case "I want Islandora users to be able to upload large files" Consider moving to a new "solution gallery" section, or a new "configuration options" page under the Sys Admin documentation 57 Audited MH RL └── JWT Authentication https://islandora.github.io/documentation/technical-documentation/jwt/ Good For Now Reference developer and/or systems administrator lists key storage locations and explains configuration of JWT authentication for secure communication between components Consider moving to installation instructions 58 Documentation for Developers Structuring menu item - not a page 59 Reviewed MH MA ├── Architecture Diagram https://islandora.github.io/documentation/technical-documentation/diagram/ Needs Work Reference developer and system administrator overview over Islandora stack components and their interaction Is "Syn" something that neede to feature in the diagram and list of components? check to make sure the diagram and list of components is up to date 60 ├── REST Documentation Structuring menu item - not a page 61 Audited MH │ ├── Introduction https://islandora.github.io/documentation/technical-documentation/using-rest-endpoints/ Needs Work Reference developer overview over the RESTful API, which allows for programmatic interaction with Islandora content link to Drupal documentation about RESTful API, if it exists; documentation about Authentication should have a separate page 62 Audited MH │ ├── GET https://islandora.github.io/documentation/technical-documentation/rest-get/ Good For Now Reference developer describe how to retrieve metadata for nodes, media and file entities, as well as binary file URLs 63 Audited MH │ ├── POST/PUT https://islandora.github.io/documentation/technical-documentation/rest-create/ Needs Work Reference developer describe how to create a node, media/file entities through the REST API unclear if JSON data in request can contain more than just the required fields (I suppose it can, add an example?); consider creating separate pages for POST and PUT, since the verbs are used for different things (creating node vs. creating file) and are used at slightly different endpoints (Drupal vs. Islandora); check and document if there are for instance file size limitations for using PUT requests (link to https://islandora.github.io/documentation/technical-documentation/uploading-large-files/) 64 Audited MH │ ├── PATCH https://islandora.github.io/documentation/technical-documentation/rest-patch/ Good For Now Reference developer describe how to update values on fields of nodes or media using the REST API 65 Audited MH │ ├── DELETE https://islandora.github.io/documentation/technical-documentation/rest-delete/ Needs Work Reference developer describe how to delete nodes, media or files using the REST API verify and document if deleting nodes/media through REST API can leave media/files orphaned, and how to mitigate that 66 Audited MH │ └── Signposting https://islandora.github.io/documentation/technical-documentation/rest-signposting/ Good For Now Reference developer, system admin describe which HTTP Link Headers Islandora returns in the response to a GET request perhaps link to https://signposting.org/ for rationale and sample use cases? If the Link Headers provided by either Drupal or Islandora are configurable, document that 67 ├── Tests Structuring menu item - not a page Procedural 68 │ ├── Running Tests https://islandora.github.io/documentation/technical-documentation/running-automated-tests/ Procedural 69 │ └── Testing Notes https://islandora.github.io/documentation/technical-documentation/testing-notes/ Procedural 70 ├── Updating drupal-project https://islandora.github.io/documentation/technical-documentation/drupal-project/ Procedural 71 Audited RL ├── Versioning Policy https://islandora.github.io/documentation/technical-documentation/versioning/ Needs Work Reference developer describe how we version the various components of Islandora? Be the "Versioning policy" that seems necessary. Page could be more explicit about how we release major/minor versions, incorporating more of the semver explanations, such as this page: https://docs.launchdarkly.com/sdk/concepts/versioning Actually, I have questions about whether the Drupal 8/9 modules are still using "core compatibility" as the first number, since Drupal 9 is HERE (the page says no) 72 Audited RL ├── Adding back ?_format=jsonld https://islandora.github.io/documentation/technical-documentation/adding_format_jsonld/ Needs Work Procedural developer Document that we changed behaviour around the 1.0 release so that devs can revert if desired This page doesn't make sense as a standalone page. It is random and bizarre. It should be part of the discussion of what Milliner is, and maybe what a URI is in the context of Islandora and Fedora. I don't think we've had this discussion. 73 ├── Updating a `deb` and adding it to Lyrasis PPA https://islandora.github.io/documentation/technical-documentation/ppa-documentation/ Procedural 74 └── Alpaca Structuring menu item - not a page Procedural 75 . ├── Alpaca Technical Stack https://islandora.github.io/documentation/alpaca/alpaca-technical-stack/ Procedural 76 . └── Alpaca Tips https://islandora.github.io/documentation/technical-documentation/alpaca_tips/ Procedural 77 Migration Structuring menu item - not a page 78 ├── Migration Overview https://islandora.github.io/documentation/technical-documentation/migration-overview/ Procedural 79 RL ├── CSV https://islandora.github.io/documentation/technical-documentation/migrate-csv/ Procedural 80 └── Islandora 7 https://islandora.github.io/documentation/technical-documentation/migrate-7x/ Procedural 81 Contributing Structuring menu item - not a page 82 Audited MA ├── How to contribute https://islandora.github.io/documentation/contributing/CONTRIBUTING/ Needs Work Procedural New contributors Explains the avenues and procedures for making contributions to the Islandora codebase and documentation This is based on the CONTRIBUTING.md file that is standard in every Islandora github repo. Because those have to stand alone, it doesn't really read well as part of the larger documentation set, and it could be more verbose in this context, expecially in terms of how ot contribute to documentation. Example of another CONTRIBUTING.md: https://github.com/Islandora/islandora/blob/7.x/CONTRIBUTING.md 83 Audited MA |── Resizing a VM https://islandora.github.io/documentation/technical-documentation/resizing_vm/ Needs Work Procedural Testers Instructions for adjusting the size allocated to a Virtual Machine so that larger files can be adjusted. These instructions are great, but it's wierd that this is a page all on its own. It should be a section or note in a page about using an Islandora VM 84 Audited MA ├── Checking Coding Standards https://islandora.github.io/documentation/technical-documentation/checking-coding-standards/ Needs Work Procedural Developers Describes the commands to run to check coding standards before making a contribution. This should be verified by some one with a dev background to make sure it's all still relevant. and it probably does not need to be its own page. it could be rolled into the description of how to do a pull request that is included in the "How to contribute" page in this same section. 85 ├── Contributing Workflow https://islandora.github.io/documentation/contributing/contributing-workflow/ Procedural 86 YS ├── Creating GitHub Issues https://islandora.github.io/documentation/contributing/create_issues/ Procedural 87 Audited YS ├── Editing Documentation https://islandora.github.io/documentation/contributing/editing-docs/ Needs Work Procedural documentation contributors, developers, committers Instuctions for editing the documentation using the online Github code editor and by creatign a pull request online. A) explain how markdown is a formatting language and that mkdocs uses it B) Refer to "THIS PROJECTS Documentation Style Guide" to exaplain the provenance of the style guide D) mention that you can request a Contributor License Agreement if you don't have one. E) explain that "Starting from the page you want to edit" refers to any of the github.io versions of this content F) mention that there is a way o contribute docs with Issues as mentioned here, by creatign an issue ...https://github.com/Islandora/documentation/blob/24155c50257de067d02aa4e6e48a381ace273d94/CONTRIBUTING.md G) specifically mention that docuemtnation can be built by forking then clonng a local copy of the repo and then one can follow a typical PR process 88 Audited YS ├── How to Build Documentation https://islandora.github.io/documentation/technical-documentation/docs-build/ Needs Work Procedural documentation contributors, developers, committers Instructions on how to build the documentation from the docuemntation repo using. Including how to install the mkdocs Python based software needed to build the docs. A) Provide macos install syntax reffering to "pip3 --user" B) Veriffy if we need to run git submodule update --init --recursive to build docs. C) Consider spelling out the steps from linked traiing video on how to test a doc pull request. (download a zip version of PR branch/commit, mkdocs --clean mkdocs, mkdocs server) D) mention that you can use ctrl-c to quit our of mkdocs on the terminal. 89 Audited YS ├── Documentation Style Guide https://islandora.github.io/documentation/contributing/docs_style_guide/ Good For Now Reference documentation contributors, developers, committers List of suggestions for how to create well formatted and well style documentation. In the bullet that mentions that doc submissiosn shoudl use Github PRs we coudl link to the "Editing Documentation" page that explains the basics of PRs. This page could cover cross page linking syntax for this project. 90 Audited MA └── Committers https://islandora.github.io/documentation/contributing/committers/ Needs Work Reference Everyone? Describes the rights and responsibilities of Islandora committers, and how new committers are nominated and approved. Also lists current and Emeritus committers. Alan Stanley is listed as working for Prince Edward Islandora [sic]. 91 Glossary https://islandora.github.io/documentation/user-documentation/glossary/ Reference 92 93 94 95 96 97 98 99 100 Quotes are not sourced from all markets and may be delayed up to 20 minutes. Information is provided 'as is' and solely for informational purposes, not for trading purposes or advice.Disclaimer       DIG Sprint April 2021 Page Suggestions Instructions Sign-up Pages (pre Nov 2020) Pages (OLD) Pages OLD     A browser error has occurred. Please press Ctrl-F5 to refresh the page and try again. A browser error has occurred. Please hold the Shift key and click the Refresh button to try again.