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 | AE | AF | AG | AH | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Review Complete | Auditor | Reviewer | Reviewer | Writer | Reviewer | Link | Audit result | Level of Effort | 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 | Done | MH | MA | ├── Collections | https://islandora.github.io/documentation/concepts/collection/ | Needs Work | Moderate 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 | Reviewed | MH | MAC | ├── Access Control | https://islandora.github.io/documentation/concepts/access-control/ | Needs Work | Expert Rewrite | 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 | Audited | MA | KC | ├── Accessibility | https://islandora.github.io/documentation/concepts/accessibility/ | Good For Now | DONE | Reference | Newcomer | Explains Islandora's accessbility features and points out to Drupal resources. | "Good for Now" in the sense that this page covers what exists; it would be great to have something more extensive, but that will probably have to wait for Islandora itself to have more to talk about on this front. | A VPAT or other standfard comparative accessibility docs would go great here. | ||||||||||||||||||||||
7 | Reviewed | MA | DK | ├── Component Overview | https://islandora.github.io/documentation/installation/component_overview/ | Good For Now | DONE | Conceptual | Stranger | Give an understanding of what components Islandora include and how they work together. | No notable problems. Should probably get a once-over from some one familiar with the technical spec to make sure it is up-to-date | This should have a link to the architecture diagram: https://islandora.github.io/documentation/technical-documentation/diagram/ (MA) | ||||||||||||||||||||||
8 | Reviewed | AB | DK | AB | ├── Modelling content in Islandora 8 vs. 7 | https://islandora.github.io/documentation/user-documentation/objects_to_resource_nodes/ | Needs Work | Moderate Work | Conceptual | Islandora 7 user | Translate between the "object" and "datastreams" model and the "nodes" and "media" model | Does get to the difference between object/datastream and nodes/media, but is repetative and has some odd turns of phrase (the first sentence of paragraph 2 in "Building Resources in Islandora" seems like it's introducing a new idea but it isn't); also has a lot of marketing-type language that seems to sell the reader on the new format that seems excessive in the documentation. Should have a new picture that shows a working viewer. | Needs work but minor editing rather than complete rewriting. | |||||||||||||||||||||
9 | Audited | DK | └── Islandora Defaults | https://islandora.github.io/documentation/reference/islandora_defaults_reference/ | Good For Now | DONE | Conceptual | DevOps, repository manager | Create sensible expectations around configurability and ongoing support | This section provides all of the defaults. I believe more context around each table would be helpful to expand the audience of this resource, including why these defaults were selected. There are also a substaintial number of blank comments within each table that could provide more information. | ||||||||||||||||||||||||
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 | DR | ├── Docker Compose (ISLE-DC) | https://islandora.github.io/documentation/installation/docker-compose/ | Needs Work | Expert Rewrite | Conceptual | Reference page: what is ISLE. Explain "best practices" like | Remove 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 | This should have a section pleading for feedback on the docs from those using them. Also, maybe a warning about the challenges of using this methid, and a subtle push to use ISLE instead. | ||||||||||||||||||||||||||||
15 | CG | │ ├── Preparing a LAPP Webserver | https://islandora.github.io/documentation/installation/manual/preparing_a_webserver/ | Needs Work | Expert Rewrite | Procedural | Site Builder | Remove jargon, check specifications. Is this locked to PHP 7.2? To PostgreSQL? | LAPP? Linux Apache PostgreSQL & PHP? | |||||||||||||||||||||||||
16 | Audited | MH | │ ├── Installing Composer, Drush, and Drupal | https://islandora.github.io/documentation/installation/manual/installing_composer_drush_and_drupal/ | Needs Work | Quick Fix | Procedural | Site Builder | Step-by-step instructions to setup Composer, Drush and Drupal on a LAPP server | move explanation of variables like DRUPAL_DB, SITE_NAME before the respective code block with the commands | ||||||||||||||||||||||||
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 | DONE | 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 | DONE | 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 | Reviewed | MC | MA | ├── Configure Blocks | https://islandora.github.io/documentation/tutorials/blocks/ | Needs Work | Moderate 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 | Done | MH | MA | ├── Create or Update a View | https://islandora.github.io/documentation/tutorials/create_update_views/ | Needs Work | Quick Fix | 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 | Reviewed | MC | MA | AB | YS | └── Video Documentation | https://islandora.github.io/documentation/user-documentation/video-docs/ | Needs Work | Quick Fix | 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 | Reviewed | DK | MAC | ├── Introduction | https://islandora.github.io/documentation/user-documentation/user-intro/ | Good For Now | DONE | Conceptual | Stranger | aimed at site admins and repository managers who need to understand and configure their Islandora | is good | This says its audience is site admins and repository managers, but I believe it is future site admins and repository managers because it is written in very basic explanitory language | ||||||||||||||||||||||
32 | Audited | AB | KC | ├── Intro to Linked Data | https://islandora.github.io/documentation/user-documentation/intro-to-ld-for-islandora-8/ | Conceptual | Islandora/Drupal Novice, Content/Collection Manager | stated goal: provide a guided reading list to anyone who wants to get up to speed on the basics of linked data within the Islandora community | for the Basics of Linked Data section, it's not clear whether the order of the links has any relation to what order it would be helpful to read/view them in. For example, I might not start with the Tim Berners Lee article; a Wikipedia overview might make more sense as an entry point for a novice. The page says that linked data was part of the design of Islandora, but doesn't include obvious information about how Linked Data is built into the new architecture; while that might not be part of this conceptual page, it seems like there should be a link to a page that does talk about how RDF is part of the structure of Islandora specifically, and specifics of what that means for migration/metadata preparation. Replace "Dublin Core in RDF" link http://dublincore.org/documents/dc-rdf/ with https://www.dublincore.org/specifications/dublin-core/dc-rdf/ ? | I checked each link but did not evaluate the content of every link. Turns out there is info about RDF mapping on the Modify or Create a Content Type page (I would not have thought to look for it there). The Update/Create an RDF Mapping section also has links to information about YAML serialization and explains that RDF mappings are stored in Drupal as YAML -- not sure why that doesn't get mentioned with the info about serialization and JSOR in the Linked Data page | ||||||||||||||||||||||||
33 | Reviewed | MA | MAC | PR Submitted | MA | ├── Versioning | https://islandora.github.io/documentation/user-documentation/versioning/ | Needs Work | Quick Fix | 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 | Done | RL | MA | │ ├── Resource Nodes | https://islandora.github.io/documentation/user-documentation/resource-nodes/ | Needs Work | Moderate Work | 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 | Reviewed | MC | AB | │ ├── Media | https://islandora.github.io/documentation/user-documentation/media/ | Good For Now | DONE | Conceptual | Islandora/Drupal Intermediate, Repository admins | Provide overview of Media and affiliated configurations and management options. | Lacks Intro/Overview section in TOC, even though there is intro text. In the "Media revisions" section, some clarification of the relationship of the resource record, revision message, and media revision would be helpful. In the "Using the Media form to replace...." section, the sentence "First, the remove button removes the file's reference on the media but does not delete the file, which, if in Fedora, will remain in Fedora." implies files can NOT be in Fedora but elsewhere - some further explanation would be helpful. In this same section, are the two highlighted methods (Removing Media with Actions, and Replacing Media via REST) recommended? Is one better than the other? While primarily conceptual, this page has some procedural info as well. | |||||||||||||||||||||||
37 | Reviewed | MC | AB | │ ├── Paged Content | https://islandora.github.io/documentation/user-documentation/paged-content/ | Good For Now | DONE | Conceptual | Islandora/Drupal Intermediate, Repository admins | Provide overview of configuration options to model and display multi-page/multi-part objects. | "...Islandora provides an Islandora Model terms, Paged Content and Page, that can be used to trigger paged content behaviors." should be corrected to read "...Islandora provides Islandora Model options Paged Content and Page that can be used to trigger paged content behaviors." "After the child resource nodes have services file Media..." should be corrected to read "After the child resource nodes have service file Media..." OpenSeadragon paginated viewer screenshot should be explicitly referenced in text above (e.g. "...as shown below"). While this page is primarily conceptual, it has some procedural info as well. | |||||||||||||||||||||||
38 | Reviewed | MR | MAC | │ └── Metadata | https://islandora.github.io/documentation/user-documentation/metadata/ | Good For Now | DONE | 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 | Audited | AB | │ ├── Modify or Create a Content Type | https://islandora.github.io/documentation/user-documentation/content_types/ | Good For Now | DONE | Procedural | Systems Admin?, Repository Manager, Content/Collection manager | describe how to create and modify ingest forms by editing fields and form display settings on Content Types via the graphical user interface (GUI), and editing the RDF mapping to accommodate changes to fields. | image of interface doesn't include tab for "Automatic label" or "translate content type" -- probably can also be ignored in this how-to (like devel) but better to match the sandbox. Sandbox was buggy when I was testing; couldn't go through all steps but instructions seemed reasonably clear. | Since coincidentally I also audited the Linked Open Data page, I put some notes there about linking to the RDF mapping that is here, and perhaps talking there about YAML and Drupal specifically. | |||||||||||||||||||||||
41 | │ ├── Configure Search | https://islandora.github.io/documentation/user-documentation/searching/ | Procedural | |||||||||||||||||||||||||||||||
42 | RL | AB | │ ├── Configure Context | https://islandora.github.io/documentation/user-documentation/context/ | Procedural | typo: "This functionality is accomplished via the "Open Seadragon" Context, which, as its configuration suggests, checks as its condition whether the node has the "Open Seadragon" tag... [change as to has] [AB] | I am left with some questions about tagging, which is mentioned in passing. Precisely where and what do you tag? Nodes? Media? Do you need to set up specific fields or field types to do so? Seems like it's not for beginners, but would be relevant to folks who want to use more context configuration. [AB] | |||||||||||||||||||||||||||
43 | Reviewed | MR | MC | Done | MH | │ ├── Multilingual | https://islandora.github.io/documentation/user-documentation/multilingual/ | Needs Work | Moderate Work | Procedural | Systems Admin, Content/Collection Managers | Describes multilingual and translation options for Islandora 8, how to configure them, and what they will look like when stored in Fedora/TripleStore | Under "Adding Languages," the second paragraph describes adding a language switcher block. It may be helpful to add details of what the user should see once the steps have been followed or perhaps a way to test to see if it worked. Same scenario with "Adding Multi-lingual Menus". To be clear - if we want to have translated versions of the Site Navigation/Menus or Repository Items, we would need to add those translations in, correct? The system doesn't automatically translate? In Field Label Translations section, it could be more explicit that the Configuration translation module must be enabled before users will be able to see/navigate to the Interface translation import options. Will the github translations repository referenced here eventually have more options, or is the singular translation available meant to be an example the community can build more translations from? In Fedora Representation section, more explanation of what to look for in the screenshot to understand how the language tags are used in indexing would help. In the Triplestore Representation section, should it read "Islandora 8 indexes the multilingual content using language tags to a triplestore"? Again more explanation of what to look for in the screenshots would help, as would an additional screenshot after the example query for filtering titles by language. | |||||||||||||||||||||
44 | Reviewed | MA | AB | │ ├── Extending Islandora | https://islandora.github.io/documentation/user-documentation/extending/ | Good For Now | DONE | 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 | Reviewed | MA | AB | RL | │ ├── Viewers | https://islandora.github.io/documentation/user-documentation/file_viewers/ | Needs Work | Moderate 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. | The question I have at the end of the page is whether the Islandora Defaults established initially constrain the possibility of adding additional viewers later. [AB] | |||||||||||||||||||||
46 | Reviewed | MA | AB | │ ├── IIIF | https://islandora.github.io/documentation/user-documentation/iiif/ | Good For Now | DONE | 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 | Reviewed | MR | AB | │ ├── OAI-PMH | https://islandora.github.io/documentation/user-documentation/oai/ | Good For Now | DONE | Conceptual | Islandora/Drupal novice, Site Builder, DAMS administrator, Collection Owners | Explains OAI capablities in Islandora 8 and a brief instructions on how to enable it. | The links under the "Enabling Islandora OAI-PMH provides" don't access anything, but otherwise no issues! | |||||||||||||||||||||||
48 | Reviewed | MR | AB | │ ├── RDF Generation | https://islandora.github.io/documentation/islandora/rdf-mapping/ | Good For Now | DONE | Conceptual | Collection/Content Owners, DAMS Administrator, Novice, | Brief overview of RDF and JSON-ld and how Islandora 8 converts metadata to RDF, how you can view the RDF, and how it's stored. | Seems straight-forward, no real notes for improvements. Mostly conceptual; procedural-ish heading "how to edit an RDF mapping" doesn't really get into all the steps [AB] | |||||||||||||||||||||||
49 | Audited | MR | │ ├── Drupal Bundle Configurations | https://islandora.github.io/documentation/islandora/drupal-bundle-configurations/ | Good For Now | DONE | Conceptual | Site builders, DAMS administrator | Overview of media and node bundles in Drupal and their configuration. Briefly describes display abilities and mapping as it relates to the bundle configurations. | |||||||||||||||||||||||||
50 | Audited | MA | │ └── Flysystem | https://islandora.github.io/documentation/technical-documentation/flysystem/ | Conceptual | Explains what Flysystem is and how it fits into Islandora, with brief instructions on configuring it. | Straddles procedural/conceptual. This both explains what Flysystem is and what it does, and also gives minimal instruction on how to configure it. | |||||||||||||||||||||||||||
51 | └── Operating an Islandora Repository | Structuring menu item - not a page | Procedural | Site builders | ||||||||||||||||||||||||||||||
52 | Reviewed | MC | MAC | . ├── Create and Manage User Accounts | https://islandora.github.io/documentation/user-documentation/users/ | Good For Now | DONE | Procedural | Islandora/Drupal Novice, Site Builder, Repository admins | High level overview of the basic user management tasks | Update "This How-To assumes a very basic familiarity with Drupal" to "This How-To assumes a basic familiarity with Drupal and user/role/permissions concepts." Or add brief definitions of role and permissions (including relationship between roles and permissions) to the overview. For users wanting to learn more Islandora-specific details, a link to the Access Control page (and any other related pages in the Islandora 8 documentation) would be helpful. | |||||||||||||||||||||||
53 | Audited | MA | . └── Usage Stats | https://islandora.github.io/documentation/user-documentation/usage-stats/ | Good For Now | DONE | Reference | Site builders | Describes Matomo in Islandora, and where to access and configure it. | Very brief. Could use more detail on how to work with Matomo, and especially how to customize it, once this is better understood. | ||||||||||||||||||||||||
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 | Moderate 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 | DONE | 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 | DONE | 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 | Quick Fix | 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 | PR Submitted | MA | │ ├── Introduction | https://islandora.github.io/documentation/technical-documentation/using-rest-endpoints/ | Needs Work | Quick Fix | 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 | DONE | 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 | Expert Rewrite | 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 | DONE | 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 | Moderate 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 | DONE | 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 | Moderate 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 | Moderate 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 | Missing instruction to import the feature after enabling the module. | |||||||||||||||||||||||||||||
80 | └── Islandora 7 | https://islandora.github.io/documentation/technical-documentation/migrate-7x/ | Procedural | |||||||||||||||||||||||||||||||
81 | Contributing | Structuring menu item - not a page | ||||||||||||||||||||||||||||||||
82 | Reviewed | MA | MAC | ├── How to contribute | https://islandora.github.io/documentation/contributing/CONTRIBUTING/ | Needs Work | Moderate 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 | Quick Fix | 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 | Moderate 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 | Audited | YS | ├── Contributing Workflow | https://islandora.github.io/documentation/contributing/contributing-workflow/ | Needs Work | Moderate Work | Procedural | New contributors, documentation contributors, developers, committers | This page starts by defining the terms user, controbutor, committer, community. Then it explains how consenus must be reached to ove forward with cahnges, as well as "socail dynamic" goals that the community strives for. Then it goes into more details of workflows that need to be followed when contributing. | A) There is a lot of conceptual overlap between this page and https://islandora.github.io/documentation/contributing/CONTRIBUTING/, we may want to see what content shoudl only exist in one of the two pages or maybe we should merge them. B) create link to apache voting rules https://www.apache.org/foundation/voting.html where it is referenced C) create a cross link when issues are first mentioned "Identify if a Github issue is needed" https://islandora.github.io/documentation/contributing/create_issues/ D) "no ticket required" may need tobe changed to "no issue required"? E) "Individual Contributor License" should crosslink https://islandora.github.io/documentation/contributing/CONTRIBUTING/#license-agreements F) "Create a Github Issue if none exists" should crosslink https://islandora.github.io/documentation/contributing/create_issues/ | ||||||||||||||||||||||||
86 | Audited | YS | ├── Creating GitHub Issues | https://islandora.github.io/documentation/contributing/create_issues/ | Needs Work | Moderate Work | Procedural | all users, documentation contributors, developers, committers | To explain the Islandora community uses GitHub issues to track bug reports, requests for improvements, requests for new features, and use cases. Specifically it teaches how to use Github to create and submit an issue. | We could go into more detail about all the details we may need for submittign a bug report, like the OS used, Docker used, "Islandora defaults" used? | ||||||||||||||||||||||||
87 | Reviewed | YS | MA | PR Submitted | YS | AB | ├── Editing Documentation | https://islandora.github.io/documentation/contributing/editing-docs/ | Needs Work | Moderate 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 H) put in explenatiosn abotu the limitatiosn ofthis "pencil" process, inlcudign how to add images refer: https://youtu.be/wVHJtL-y7P0 | The changes in the PR look good to me! AB https://github.com/Islandora/documentation/pull/1837/files | |||||||||||||||||||
88 | Reviewed | YS | MA | PR Submitted | YS | AB | ├── How to Build Documentation | https://islandora.github.io/documentation/technical-documentation/docs-build/ | Needs Work | Moderate 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 out of mkdocs on the terminal. | ||||||||||||||||||||
89 | Reviewed | YS | MA | Done | YS | MA | ├── Documentation Style Guide | https://islandora.github.io/documentation/contributing/docs_style_guide/ | Good For Now | Quick Fix | 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 | Reviewed | MA | MAC | Done | MA | └── Committers | https://islandora.github.io/documentation/contributing/committers/ | Needs Work | Quick Fix | 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/ | Good For Now | DONE | Reference | |||||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||||||||||
100 |