Skip to content

Commit

Permalink
Fix broken links and anchors. Also add MIG definitions for GUI and Is…
Browse files Browse the repository at this point in the history
…landora Model. (#2341)
  • Loading branch information
rosiel authored Aug 14, 2024
1 parent f108f80 commit ad260d1
Show file tree
Hide file tree
Showing 36 changed files with 105 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/node-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,6 @@ Media (file) and tag it as "Transcript". See [Audio](../models/audio.md) and
!!! note "Standard vs Multi-file media model"
This describes the standard file-media relationship in Islandora.
There is an alternative method of arranging files and their derivatives
which we call the ["Multi-file media"](../user-documentation/media/#multi-file-media) method.
which we call the ["Multi-file media"](../user-documentation/media.md#multi-file-media) method.


4 changes: 2 additions & 2 deletions docs/concepts/starter-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ The Islandora Starter Site contains no code, only references to other modules an

To experience the full Islandora Starter Site, it requires access to external services such as Solr,
Fedora, Alpaca, and Matomo. It is therefore suggested to deploy the Starter Site using one of our
two deployment platforms: [ISLE-DC](../../installation/docker-local) (using the `make starter` or `make starter_dev` commands), or
the [Islandora Playbook](../../installation/playbook) (using the `starter` (default) or `starter_dev` option in the Vagrantfile).
deployment platforms: [ISLE-DC](../installation/docker/isle-dc/docker-local.md) (using the `make starter` or `make starter_dev` commands), [ISLE Site Template](../installation/docker/site-template/site-template.md), or
the [Islandora Playbook](../installation/playbook.md) (using the `starter` (default) or `starter_dev` option in the Vagrantfile).

2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Islandora:
[//]: # (Allowing bulk uploads to be processed without affecting the server... would be the ideal right? but right now they're on the same server. Is just saying "scalability" ok?)

- **Offers digital preservation features** - Using a robust storage layer for preservation (Fedora), and generating technical metadata with FITS, are digital preservation tools provided by our automated installation methods. Community members have created additional features for doing [digital preservation using Islandora](https://github.com/mjordan/digital_preservation_using_islandora), which are not yet part of our automated setup.
- **Exposes data to harvesters** - Metadata about resources is available as linked data through the [JSON-LD serialization module](https://github.com/Islandora/jsonld), and can be made available through Drupal, Fedora, or a triplestore. Islandora Starter Site also offers a full configuration for exposing [OAI-PMH](user-documentation/metadata_harvesting/#oai-pmh) so that metadata can be harvested by aggregators, and [IIIF support](https://github.com/Islandora/islandora/tree/8.x-1.x/modules/islandora_iiif) means images in Islandora can be viewed in any IIIF-compliant viewer.
- **Exposes data to harvesters** - Metadata about resources is available as linked data through the [JSON-LD serialization module](https://github.com/Islandora/jsonld), and can be made available through Drupal, Fedora, or a triplestore. Islandora Starter Site also offers a full configuration for exposing [OAI-PMH](user-documentation/metadata-harvesting.md#oai-pmh) so that metadata can be harvested by aggregators, and [IIIF support](https://github.com/Islandora/islandora/tree/8.x-1.x/modules/islandora_iiif) means images in Islandora can be viewed in any IIIF-compliant viewer.
- **Offers flexibility** - As Islandora content is Drupal content, migrations and batch editing can be done through Drupal's built-in migrate framework and vocabularies can be created using Drupal taxonomies. Contributed Drupal modules such as [Solr Search API](https://www.drupal.org/project/search_api_solr) enable in-site search, and [Matomo Analytics](https://www.drupal.org/project/matomo) provides usage metrics for site analytics.
- **Is a community** - A [dedicated, active community of users and developers](https://groups.google.com/forum/#!forum/islandora) is working to push new features, collaborate on improvements, design custom solutions, and create extended functionality. Some of these for Islandora 8 take the form of [Recipes](https://github.com/Islandora-Labs/Islandora-Cookbook).

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/docker/isle-dc/docker-custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image.

## Creating your Image

In order to generate that custom Drupal image we need to [set up a development environment](../docker-local). You will do this
In order to generate that custom Drupal image we need to [set up a development environment](docker-local.md). You will do this
on your development computer, rather than your production server.

Once your development site is set up you will need somewhere to store your custom Drupal image. You should create a private
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/docker/isle-dc/docker-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Tagged versions are available [here](https://github.com/Islandora-Devops/isle-dc

## Getting Started

If you don't already have a Drupal site, you'll be given a basic setup using Drupal 9 and the
If you don't already have a Drupal site, you'll be given a basic setup using Drupal 10 and the
[Islandora Starter Site](https://github.com/Islandora-Devops/islandora-starter-site).

If you do already have a Drupal site, use git to clone it into place as the `codebase` folder.
Expand Down Expand Up @@ -56,7 +56,7 @@ make starter

to install the Drupal site in your `codebase` folder and spin up all the other containers with it.

Enjoy your Islandora instance! Check out the [basic usage documentation](../docker-basic-usage) to see
Enjoy your Islandora instance! Check out the [basic usage documentation](docker-basic-usage.md) to see
all the endpoints that are available and how to do things like start and stop Islandora. Your passwords,
including the Drupal admin password, can be found in the `secrets/live` directory after you run `make starter`.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/docker/site-template/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Drupal updates are performed through composer on your development site. Once the

### Development

Composer commands need to [run in your Drupal container](/documentation/installation/docker/site-template/containers.md). For example:
Composer commands need to [run in your Drupal container](../docker-prereq.md#containers). For example:

​​`docker compose exec drupal-dev composer update -W`

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/manual/configuring-drupal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuring Drupal

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

After all of the above pieces are in place, installed, configured, started, and otherwise prepared, the last thing we need to do is to finally configure the front-end Drupal instance to wire all the installed components together.

Expand Down Expand Up @@ -53,7 +53,7 @@ drush -y cr
## Islandora

!!! note "Skip this by using the Islandora Starter Site"
The Islandora Starter Site, which was presented as an option in the ["Installing Composer, Drush, and Drupal"](installing_composer_drush_and_drupal) step,
The Islandora Starter Site, which was presented as an option in the ["Installing Composer, Drush, and Drupal"](installing-composer-drush-and-drupal.md) step,
installs Islandora and other modules and configures them, allowing you to skip this section. You may want to use this manual method in the case where you want
to pick and choose which Islandora modules you use.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing Composer, Drush, and Drupal

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

## In this section, we will install:

Expand Down Expand Up @@ -131,7 +131,7 @@ exit

## Install Drupal using Drush

The Drupal installation process can be done through the GUI in a series of form steps, or can be done quickly using Drush's `site-install` command. It can be invoked with the full list of parameters (such as `--db-url` and `--site-name`), but if parameters are missing, they will be asked of you interactively.
The Drupal installation process can be done through the [GUI](../../user-documentation/glossary.md#gui) in a series of form steps, or can be done quickly using Drush's `site-install` command. It can be invoked with the full list of parameters (such as `--db-url` and `--site-name`), but if parameters are missing, they will be asked of you interactively.

### Option 1: Site install the Starter Site with existing configs

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/manual/installing-crayfish.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing Crayfish

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

## In this section, we will install:
- [FITS Web Service](https://projects.iq.harvard.edu/fits), a webservice for identifying file metadata
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/manual/installing-solr.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing Solr

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

## In this section, we will install:
- [Apache Solr 8](https://lucene.apache.org/solr/), the search engine used to index and find Drupal content
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/manual/installing-tomcat-and-cantaloupe.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing Tomcat and Cantaloupe

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

## In this section, we will install:

Expand Down Expand Up @@ -185,4 +185,4 @@ If you have trouble connecting, check the status of your port and allow it if ne
```bash
sudo ufw status verbose
sudo ufw allow 8182/tcp
```
```
2 changes: 1 addition & 1 deletion docs/installation/manual/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Introduction

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

!!! notice
The manual installation guide is not intended to describe *the* Islandora installation but rather *an* Islandora installation. The server created using this guide is not hardened, will not be easily scalable, and the components may not be configured in a way you consider easy to work with. A production instance of Islandora should be installed and maintained by a professional with an understanding of Linux and server administration.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/manual/preparing-a-webserver.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Preparing a LAPP Server

!!! warning "Needs Maintenance"
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../../contributing/CONTRIBUTING).
The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see [Contributing](../../contributing/CONTRIBUTING.md).

## In this section, we will install:

Expand Down
6 changes: 3 additions & 3 deletions docs/installation/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ Alternately, you can use Docker and install the Online Sandbox repository locall

## Ansible Playbook

To provision a local Vagrant or remote Ubuntu virtual machine (without Docker), you can use the [Islandora Ansible Playbook](https://github.com/Islandora-Devops/islandora-playbook). The playbook results in all services installed on a single machine, but can be altered to spread services across various machines. This is a full-fledged VM where you can install modules and themes using Composer. This method requires basic command-line usage and it's advantageous if you are familiar with provisioning software on Ubuntu. This Playbook is suitable for local or production use, though local use (through VirtualBox and Vagrant) is not supported yet by Apple hardware (i.e. M1/M2 machines). See documentation: [Installation - Ansible Playbook](installation/playbook) for more details.
To provision a local Vagrant or remote Ubuntu virtual machine (without Docker), you can use the [Islandora Ansible Playbook](https://github.com/Islandora-Devops/islandora-playbook). The playbook results in all services installed on a single machine, but can be altered to spread services across various machines. This is a full-fledged VM where you can install modules and themes using Composer. This method requires basic command-line usage and it's advantageous if you are familiar with provisioning software on Ubuntu. This Playbook is suitable for local or production use, though local use (through VirtualBox and Vagrant) is not supported yet by Apple hardware (i.e. M1/M2 machines). See documentation: [Installation - Ansible Playbook](playbook.md) for more details.

## ISLE Site Template

[ISLE Site Template](https://github.com/Islandora-Devops/isle-site-template) uses Docker and is based off images created by [ISLE Buildkit](https://github.com/Islandora-Devops/isle-buildkit), but is a simpler tool than ISLE-DC. This is a full-fledged Docker installation where you can install modules and themes using Composer, either by executing commands in the container or by using the built-in IDE. It is suitable for local development or production. See documentation: [Installation - Site Template](http://localhost:8111/documentation/installation/docker/site-template/site-template/) for more details.
[ISLE Site Template](https://github.com/Islandora-Devops/isle-site-template) uses Docker and is based off images created by [ISLE Buildkit](https://github.com/Islandora-Devops/isle-buildkit), but is a simpler tool than ISLE-DC. This is a full-fledged Docker installation where you can install modules and themes using Composer, either by executing commands in the container or by using the built-in IDE. It is suitable for local development or production. See documentation: [Installation - Site Template](docker/site-template/site-template.md) for more details.

## ISLE-DC

[ISLE-DC](https://github.com/Islandora-Devops/isle-dc) uses Docker and provisions each service in the Islandora stack in a separate container. The containers are also based off of the images in ISLE Buildkit. ISLE-DC uses the [GNU Make](https://www.gnu.org/software/make/) tool to provide several shortcuts to performing common management functions. It is suitable for local development or production. See documentation: [Installation - Docker ISLE](installation/docker-introduction) for more details.
[ISLE-DC](https://github.com/Islandora-Devops/isle-dc) uses Docker and provisions each service in the Islandora stack in a separate container. The containers are also based off of the images in ISLE Buildkit. ISLE-DC uses the [GNU Make](https://www.gnu.org/software/make/) tool to provide several shortcuts to performing common management functions. It is suitable for local development or production. See documentation: [Installation - Docker ISLE](docker/isle-dc/docker-local.md) for more details.


2 changes: 1 addition & 1 deletion docs/models/video.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Islandora Starter Site sets up a context to automatically create this derivative
* The Video media is tagged with the "Original File" term (a term with External URI `http://pcdm.org/use#OriginalFile`)
* The media's parent node is tagged with the "Video" model (a term with External URI `http://purl.org/coar/resource_type/c_18cc`)

The mimetype formats allowed by Homarus are configured in Homarus itself - see [Installing Crayfish](../installation/manual/installing_crayfish#homarus-audiovideo-derivatives)
The mimetype formats allowed by Homarus are configured in Homarus itself - see [Installing Crayfish](../installation/manual/installing-crayfish.md#homarus-audiovideo-derivatives)

## Display

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Downloading and Enabling Drupal Modules and Themes

Islandora can make use of the majority of Drupal [modules](https://www.drupal.org/project/project_module) and [themes](https://www.drupal.org/project/project_theme). Common use cases have been documented in the [Islandora Cookbook](/documentation/user-documentation/extending/). There are several ways to download and install Drupal modules. Please refer to [this guide](https://www.drupal.org/docs/extending-drupal) on Drupal.org.
Islandora can make use of the majority of Drupal [modules](https://www.drupal.org/project/project_module) and [themes](https://www.drupal.org/project/project_theme). Common use cases have been documented in the [Islandora Cookbook](../user-documentation/extending.md). There are several ways to download and install Drupal modules. Please refer to [this guide](https://www.drupal.org/docs/extending-drupal) on Drupal.org.

[Composer](https://www.drupal.org/docs/develop/using-composer/using-composer-to-install-drupal-and-manage-dependencies) is the recommended method to install and update drupal modules and themes in Islandora. Drupal modules provided by Islandora can be accessed at the `drupal/` namespace.
```shell
Expand Down
Loading

0 comments on commit ad260d1

Please sign in to comment.