From d2d7cfae49375ef5b10becdc8b024aa2fa84cb23 Mon Sep 17 00:00:00 2001 From: Seth Shaw <108362375+seth-shaw-asu@users.noreply.github.com> Date: Wed, 17 Jul 2024 10:30:14 -0700 Subject: [PATCH] More minor installation docs formatting/consistency edits (#2333) * fix note * Fix ubuntu version used * Update installing-crayfish.md --- docs/installation/manual/installing-crayfish.md | 5 ++--- docs/installation/manual/introduction.md | 4 ++-- docs/installation/manual/preparing-a-webserver.md | 4 ++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/installation/manual/installing-crayfish.md b/docs/installation/manual/installing-crayfish.md index 8bd9e532b..4f2f6d76b 100644 --- a/docs/installation/manual/installing-crayfish.md +++ b/docs/installation/manual/installing-crayfish.md @@ -289,9 +289,8 @@ Finally, we need appropriate Apache configurations for Crayfish; these will allo Each endpoint we need to be able to connect to will get its own `.conf` file, which we will then enable. -**NOTICE** - -These configurations would potentially have collisions with Drupal routes, if any are created in Drupal with the same name. If this is a concern, it would likely be better to reserve a subdomain or another port specifically for Crayfish. For the purposes of this installation guide, these endpoints will suffice. +!!! warning "Possible Route Collisions" + These configurations would potentially have collisions with Drupal routes, if any are created in Drupal with the same name. If this is a concern, it would likely be better to reserve a subdomain or another port specifically for Crayfish. For the purposes of this installation guide, these endpoints will suffice. `/etc/apache2/conf-available/Homarus.conf | root:root/644` ``` diff --git a/docs/installation/manual/introduction.md b/docs/installation/manual/introduction.md index c04119bb1..419adb6b2 100644 --- a/docs/installation/manual/introduction.md +++ b/docs/installation/manual/introduction.md @@ -6,7 +6,7 @@ !!! 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. -This guide will contain generalized steps on installation and configuration of the various components, but will contain specific example commands for executing these steps on an Ubuntu 18.04 Server. +This guide will contain generalized steps on installation and configuration of the various components, but will contain specific example commands for executing these steps on an Ubuntu 20.04 Server. ## Some Prerequisite Knowledge @@ -115,4 +115,4 @@ The most common issues you will likely run into when manually provisioning a ser - Files or directories are not owned by the user who needs access to them, and can therefore not be written to. Check the ownership of files using `ls -la`, and ensure their ownership using `chown USER` for files, and `chown -R USER` for directories - Replacement variables were left in place in files specified by the guide. Ensure any replacement variables such as server addresses and passwords are swapped out when writing files to the server -For any other issues, don't hesitate to email the [mailing list](mailto:islandora@googlegroups.com) to ask for help. If you think that a part of the installation documentation is incorrect or could be improved, please create an issue in the [documentation issues queue](http://github.com/Islandora/documentation/issues) and give it a `documentation` tag. Bear in mind that this guide is built for Ubuntu 18.04 and attempts to give generalized instructions; you will likely naturally encounter situations where your own environment needs to differ from the guide. +For any other issues, don't hesitate to email the [mailing list](mailto:islandora@googlegroups.com) to ask for help. If you think that a part of the installation documentation is incorrect or could be improved, please create an issue in the [documentation issues queue](http://github.com/Islandora/documentation/issues) and give it a `documentation` tag. Bear in mind that this guide is built for Ubuntu 20.04 and attempts to give generalized instructions; you will likely naturally encounter situations where your own environment needs to differ from the guide. diff --git a/docs/installation/manual/preparing-a-webserver.md b/docs/installation/manual/preparing-a-webserver.md index e22ab70fd..b1a9cdcb0 100644 --- a/docs/installation/manual/preparing-a-webserver.md +++ b/docs/installation/manual/preparing-a-webserver.md @@ -72,7 +72,7 @@ sudo su `whoami` ## PHP 8.x -!! note "Installing Alternate Versions" +!!! note "Installing Alternate Versions" Although the instructions below will install PHP 8.3, the instructions should work for future versions by replacing the `8.3` with whatever version you are attempting to install. ### Install PHP 8.x @@ -114,4 +114,4 @@ sudo service mysql status # press "q" to exit sudo ss -tap | grep mysql sudo service mysql restart sudo journalctl -u mysql # helps troubleshooting -``` \ No newline at end of file +```