ABCDEFGHIJKLMNOPQRSTUVWXYZAAABACAD
1
Review Complete
AuditorReviewerLinkStatusTypeAudienceGoalPROBLEMSNOTES
2
Abouthttps://islandora.github.io/documentation/Good For NowConceptualStrangerExplains at a high level what islandora does
3
ConceptsStructuring menu item - not a page
4
ReviewedDIGMA├── Collectionshttps://islandora.github.io/documentation/concepts/collection/Needs WorkConceptualNewcomerExplain 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
AuditedMH├── Access Controlhttps://islandora.github.io/documentation/concepts/access-control/Needs WorkConceptualDevOps, repository managerExplain what mechanism(s) for access control are available and how restrictions affect Islandora repo contentMixes 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├── Accessibilityhttps://islandora.github.io/documentation/concepts/accessibility/Conceptual
7
├── Component Overviewhttps://islandora.github.io/documentation/installation/component_overview/ConceptualStrangerGive 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. 7https://islandora.github.io/documentation/user-documentation/objects_to_resource_nodes/ConceptualIslandora 7 userTranslate between the "object" and "datastreams" model and the "nodes" and "media" model
9
└── Islandora Defaultshttps://islandora.github.io/documentation/reference/islandora_defaults_reference/ConceptualCreate sensible expectations around configurability and ongoing support
10
InstallationStructuring menu item - not a pageProposed 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/ConceptualReference page: what is ISLE. Explain "best practices" like Remov tutorialProposed sub-page: Tutorial Create a Dev-Environment; procedural; geared towards 'baby devs'; Hand-hold walkthrough of creating a local sandbox
12
├── Ansible Playbookhttps://islandora.github.io/documentation/installation/playbook/Needs WorkProcedural
13
├── Manual InstallationStructuring menu item - not a pageProcedural
14
│ ├── Introductionhttps://islandora.github.io/documentation/installation/manual/introduction/ProceduralSite BuilderAssumes, but does not specify Ubuntu (or similar) operating system
15
CG│ ├── Preparing a LAPP Webserverhttps://islandora.github.io/documentation/installation/manual/preparing_a_webserver/Needs WorkProceduralSite BuilderRemove jargon, check specifications. Is this locked to PHP 7.2? To PostgreSQL?LAPP? Linux Apache PostgreSQL & PHP?
16
│ ├── Installing Composer, Drush, and Drupalhttps://islandora.github.io/documentation/installation/manual/installing_composer_drush_and_drupal/ProceduralSite Builder
17
│ ├── Installing Tomcat and Cantaloupehttps://islandora.github.io/documentation/installation/manual/installing_tomcat_and_cantaloupe/ProceduralSite Builder
18
│ ├── Installing Fedora, Syn, and Blazegraphhttps://islandora.github.io/documentation/installation/manual/installing_fedora_syn_and_blazegraph/ProceduralSite Builder
19
│ ├── Installing Solrhttps://islandora.github.io/documentation/installation/manual/installing_solr/ProceduralSite Builder
20
│ ├── Installing Crayfishhttps://islandora.github.io/documentation/installation/manual/installing_crayfish/ProceduralSite Builder
21
│ ├── Installing Karaf and Alpacahttps://islandora.github.io/documentation/installation/manual/installing_karaf_and_alpaca/ProceduralSite Builder
22
│ └── Configuring Drupalhttps://islandora.github.io/documentation/installation/manual/configuring_drupal/ProceduralSite Builder
23
└── Installing Moduleshttps://islandora.github.io/documentation/technical-documentation/install-enable-drupal-modules/ProceduralSite Builder
24
TutorialsStructuring menu item - not a page
25
ReviewedMCMAC├── Create a Resource Nodehttps://islandora.github.io/documentation/tutorials/create-a-resource-node/Good For NowProcedural
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
AuditedMCKC├── Create a Collectionhttps://islandora.github.io/documentation/tutorials/how-to-create-collection/Good For NowProcedural
Islandora/Drupal Novice, Content/Collection Manager
Walkthrough of creating and populating a Collection in UIMinor 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
AuditedMC├── Configure Blockshttps://islandora.github.io/documentation/tutorials/blocks/Needs WorkProceduralIslandora/Drupal Novice, Site BuilderWalkthrough of general Block layout and Context configurationsLack 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
ReviewedMCMAC├── Create or Update a Viewhttps://islandora.github.io/documentation/tutorials/create_update_views/Needs WorkProceduralIslandora/Drupal Novice, Site BuilderWalkthrough of how to modify existing and create new viewsScreenshot 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
AuditedMC└── Video Documentationhttps://islandora.github.io/documentation/user-documentation/video-docs/Needs WorkReferenceIslandora/Drupal Novice, consumers of documentation in video formatProvide browsable list of video tutorials available, organized by broad categoriesLacks 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
DocumentationStructuring menu item - not a page
31
├── Introductionhttps://islandora.github.io/documentation/user-documentation/user-intro/Conceptual
32
ABKC├── Intro to Linked Datahttps://islandora.github.io/documentation/user-documentation/intro-to-ld-for-islandora-8/Conceptual
33
AuditedMA├── Versioninghttps://islandora.github.io/documentation/user-documentation/versioning/Needs WorkConceptualIslandora/Drupal Novice, Site BuilderDescribes how versioning works in Islandora and Fedora+Islandora, including the workflowSpecifically 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
ReviewedMCMA│ ├── Resource Nodeshttps://islandora.github.io/documentation/user-documentation/resource-nodes/ConceptualIslandora/Drupal Novice, Repository adminsProvide 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│ ├── Mediahttps://islandora.github.io/documentation/user-documentation/media/Conceptual
37
MC│ ├── Paged Contenthttps://islandora.github.io/documentation/user-documentation/paged-content/Conceptual
38
MR│ └── Metadatahttps://islandora.github.io/documentation/user-documentation/metadata/Good For NowConceptualSystems Admin, Users, NoviceTo describe the basic metadata configuration, how it's stored, and ways it can be configuredOne 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 Typehttps://islandora.github.io/documentation/user-documentation/content_types/Procedural
41
│ ├── Configure Searchhttps://islandora.github.io/documentation/user-documentation/searching/Procedural
42
RL│ ├── Configure Contexthttps://islandora.github.io/documentation/user-documentation/context/Procedural
43
MRMC│ ├── Multilingualhttps://islandora.github.io/documentation/user-documentation/multilingual/Procedural
44
AuditedMA│ ├── Extending Islandorahttps://islandora.github.io/documentation/user-documentation/extending/Good For NowReferenceSite buildersTo 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
AuditedMA│ ├── Viewershttps://islandora.github.io/documentation/user-documentation/file_viewers/Needs WorkConceptualSite buildersExplains how viewers work, including a configuration exampleAttempts 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│ ├── IIIFhttps://islandora.github.io/documentation/user-documentation/iiif/ReferenceSite buildersExplains 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-PMHhttps://islandora.github.io/documentation/user-documentation/oai/Procedural
48
MR│ ├── RDF Generationhttps://islandora.github.io/documentation/islandora/rdf-mapping/Procedural
49
MR│ ├── Drupal Bundle Configurationshttps://islandora.github.io/documentation/islandora/drupal-bundle-configurations/Procedural
50
│ └── Flysystemhttps://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 Accountshttps://islandora.github.io/documentation/user-documentation/users/Procedural
53
. └── Usage Statshttps://islandora.github.io/documentation/user-documentation/usage-stats/Procedural
54
System Administrator DocumentationStructuring menu item - not a page
55
ReviewedMHMA├── Updating Drupalhttps://islandora.github.io/documentation/technical-documentation/updating_drupal/Needs WorkProceduralsystem administratorexplain steps needed to update the Drupal component of the Islandora stackcheck 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 modulesMissing pages: Describe how to update any other component of the stack that requires special instructions
56
AuditedMHRL├── Uploading large fileshttps://islandora.github.io/documentation/technical-documentation/uploading-large-files/Good For NowReferencesystem administratorexplain 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
AuditedMHRL└── JWT Authenticationhttps://islandora.github.io/documentation/technical-documentation/jwt/Good For NowReference
developer and/or systems administrator
lists key storage locations and explains configuration of JWT authentication for secure communication between componentsConsider moving to installation instructions
58
Documentation for DevelopersStructuring menu item - not a page
59
ReviewedMHMA├── Architecture Diagramhttps://islandora.github.io/documentation/technical-documentation/diagram/Needs WorkReferencedeveloper and system administratoroverview 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 DocumentationStructuring menu item - not a page
61
AuditedMH│ ├── Introductionhttps://islandora.github.io/documentation/technical-documentation/using-rest-endpoints/Needs WorkReferencedeveloperoverview over the RESTful API, which allows for programmatic interaction with Islandora contentlink to Drupal documentation about RESTful API, if it exists; documentation about Authentication should have a separate page
62
AuditedMH│ ├── GEThttps://islandora.github.io/documentation/technical-documentation/rest-get/Good For NowReferencedeveloperdescribe how to retrieve metadata for nodes, media and file entities, as well as binary file URLs
63
AuditedMH│ ├── POST/PUThttps://islandora.github.io/documentation/technical-documentation/rest-create/Needs WorkReferencedeveloperdescribe how to create a node, media/file entities through the REST APIunclear 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
AuditedMH│ ├── PATCHhttps://islandora.github.io/documentation/technical-documentation/rest-patch/Good For NowReferencedeveloperdescribe how to update values on fields of nodes or media using the REST API
65
AuditedMH│ ├── DELETEhttps://islandora.github.io/documentation/technical-documentation/rest-delete/Needs WorkReferencedeveloperdescribe how to delete nodes, media or files using the REST APIverify and document if deleting nodes/media through REST API can leave media/files orphaned, and how to mitigate that
66
AuditedMH│ └── Signpostinghttps://islandora.github.io/documentation/technical-documentation/rest-signposting/Good For NowReferencedeveloper, system admindescribe which HTTP Link Headers Islandora returns in the response to a GET requestperhaps 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
├── TestsStructuring menu item - not a pageProcedural
68
│ ├── Running Testshttps://islandora.github.io/documentation/technical-documentation/running-automated-tests/Procedural
69
│ └── Testing Noteshttps://islandora.github.io/documentation/technical-documentation/testing-notes/Procedural
70
├── Updating drupal-projecthttps://islandora.github.io/documentation/technical-documentation/drupal-project/Procedural
71
AuditedRL├── Versioning Policyhttps://islandora.github.io/documentation/technical-documentation/versioning/Needs WorkReferencedeveloperdescribe 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
AuditedRL├── Adding back ?_format=jsonldhttps://islandora.github.io/documentation/technical-documentation/adding_format_jsonld/Needs WorkProceduraldeveloperDocument that we changed behaviour around the 1.0 release so that devs can revert if desiredThis 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 PPAhttps://islandora.github.io/documentation/technical-documentation/ppa-documentation/Procedural
74
└── AlpacaStructuring menu item - not a pageProcedural
75
. ├── Alpaca Technical Stackhttps://islandora.github.io/documentation/alpaca/alpaca-technical-stack/Procedural
76
. └── Alpaca Tipshttps://islandora.github.io/documentation/technical-documentation/alpaca_tips/Procedural
77
MigrationStructuring menu item - not a page
78
├── Migration Overviewhttps://islandora.github.io/documentation/technical-documentation/migration-overview/Procedural
79
RL├── CSVhttps://islandora.github.io/documentation/technical-documentation/migrate-csv/Procedural
80
└── Islandora 7https://islandora.github.io/documentation/technical-documentation/migrate-7x/Procedural
81
ContributingStructuring menu item - not a page
82
AuditedMA├── How to contributehttps://islandora.github.io/documentation/contributing/CONTRIBUTING/Needs WorkProceduralNew contributorsExplains the avenues and procedures for making contributions to the Islandora codebase and documentationThis 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
AuditedMA |── Resizing a VMhttps://islandora.github.io/documentation/technical-documentation/resizing_vm/Needs WorkProceduralTestersInstructions 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
AuditedMA├── Checking Coding Standardshttps://islandora.github.io/documentation/technical-documentation/checking-coding-standards/Needs WorkProceduralDevelopersDescribes 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 Workflowhttps://islandora.github.io/documentation/contributing/contributing-workflow/Procedural
86
YS├── Creating GitHub Issueshttps://islandora.github.io/documentation/contributing/create_issues/Procedural
87
AuditedYS├── Editing Documentationhttps://islandora.github.io/documentation/contributing/editing-docs/Needs WorkProcedural
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
AuditedYS├── How to Build Documentationhttps://islandora.github.io/documentation/technical-documentation/docs-build/Needs WorkProcedural
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
AuditedYS├── Documentation Style Guidehttps://islandora.github.io/documentation/contributing/docs_style_guide/Good For NowReference
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
AuditedMA└── Committershttps://islandora.github.io/documentation/contributing/committers/Needs WorkReferenceEveryone?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
Glossaryhttps://islandora.github.io/documentation/user-documentation/glossary/Reference
92
93
94
95
96
97
98
99
100