From 1c7f54d9dfc10d11bf86d60612396598a721a48e Mon Sep 17 00:00:00 2001 From: Brian Zelip Date: Mon, 25 Nov 2024 11:33:18 -0500 Subject: [PATCH] Make all internal links absolute from / --- src/content/docs/about/authoring.md | 33 ++++++++++++------- src/content/docs/about/development.md | 2 +- src/content/docs/administration/upgrading.md | 12 +++---- .../docs/administration/upgrading_1_1_0.md | 4 +-- .../docs/administration/upgrading_1_1_1.md | 2 +- .../docs/administration/upgrading_1_5_0.md | 12 +++---- .../docs/administration/upgrading_2_1_0.md | 2 +- src/content/docs/administration/windows.md | 2 +- src/content/docs/architecture/api.md | 2 +- src/content/docs/architecture/database.md | 4 +-- .../docs/customization/configuration.md | 2 +- src/content/docs/customization/plugins.md | 2 +- src/content/docs/customization/theming.md | 2 +- src/content/docs/development/dev.md | 6 ++-- src/content/docs/development/release.md | 2 +- src/content/docs/development/ui_test.md | 2 +- .../migrate_from_archivists_toolkit.md | 4 +-- .../docs/migrations/migrate_from_archon.md | 2 +- .../docs/migrations/migration_tools.md | 4 +-- src/content/docs/provisioning/domains.md | 2 +- src/content/docs/provisioning/solr.md | 8 ++--- src/content/docs/provisioning/tuning.md | 6 ++-- 22 files changed, 64 insertions(+), 53 deletions(-) diff --git a/src/content/docs/about/authoring.md b/src/content/docs/about/authoring.md index 6db5bcd..2c11941 100644 --- a/src/content/docs/about/authoring.md +++ b/src/content/docs/about/authoring.md @@ -55,30 +55,41 @@ This is demo text under the Third level heading section. ### Links -Create a link by wrapping the link text in brackets (`[ ]`) followed by the external link URL, or internal link path, wrapped in parentheses (`( )`). +Create a link by wrapping the link text in brackets (`[ ]`) immediately followed by the external link URL, or internal link path, wrapped in parentheses (`( )`). ```md [text](URL or path) ``` -There should be no space between the wrapped text and URL. When linking to an internal Tech Docs page, use the relative path from the current page, and omit the page file extension (`.md`). +Be sure not to include any space between the wrapped text and URL. -:::note[Internal link requirements] -Links to other Tech Docs pages should: +```md + -1. be relative from the current file -2. not include the file extension (`.md`) +See the [TechDocs source code](https://github.com/archivesspace/tech-docs). +``` -::: +#### Internal links -```md - +When linking to another Tech Docs page, start with a forward slash (`/`), follwed by the location of the page as found in the `src/content/docs/` directory, and omit the file extension (`.md`). -Here's an internal link to the [releases page](../development/releases). +```md +✅ [Running with external Solr](/provisioning/solr) -Here's an [external link](https://github.com/archivesspace/tech-docs). +❌ [Running with external Solr](provisioning/solr) +❌ [Running with external Solr](./provisioning/solr) +❌ [Running with external Solr](../provisioning/solr) +❌ [Running with external Solr](/provisioning/solr.md) ``` +:::note[Internal link requirements] +Links to other Tech Docs pages should: + +1. start with a forward slash (`/`) +2. not include the file extension (`.md`) + +::: + ### Emphasizing text Wrap text to be emphasized with `_ ` for italics, `**` for bold, and `~~` for strikethrough. diff --git a/src/content/docs/about/development.md b/src/content/docs/about/development.md index f1ac7a7..7ef4c5c 100644 --- a/src/content/docs/about/development.md +++ b/src/content/docs/about/development.md @@ -8,7 +8,7 @@ next: label: Home --- -Tech Docs is a [Node.js](https://nodejs.org) application, built with [Astro](https://astro.build/) and its [Starlight](https://starlight.astro.build/) documentation site framework. The source code is hosted on [GitHub](https://github.com/archivesspace/tech-docs). The site is statically built and (temporarily) hosted via [Cloudflare Pages](https://pages.cloudflare.com/). Content is written in [Markdown](./authoring#commonly-used-markdown-syntax). When the source code changes, a new set of static files are generated and published shortly after. +Tech Docs is a [Node.js](https://nodejs.org) application, built with [Astro](https://astro.build/) and its [Starlight](https://starlight.astro.build/) documentation site framework. The source code is hosted on [GitHub](https://github.com/archivesspace/tech-docs). The site is statically built and (temporarily) hosted via [Cloudflare Pages](https://pages.cloudflare.com/). Content is written in [Markdown](/about/authoring#commonly-used-markdown-syntax). When the source code changes, a new set of static files are generated and published shortly after. ## Dependencies diff --git a/src/content/docs/administration/upgrading.md b/src/content/docs/administration/upgrading.md index 828711e..db5304e 100644 --- a/src/content/docs/administration/upgrading.md +++ b/src/content/docs/administration/upgrading.md @@ -2,16 +2,16 @@ title: Upgrading to a new release --- -- **[Special considerations when upgrading to v1.1.0](./upgrading_1_1_0)** -- **[Special considerations when upgrading to v1.1.1](./upgrading_1_1_1)** -- **[Special considerations when upgrading from v1.4.2 to 1.5.x (these considerations also apply when upgrading from 1.4.2 to any version through 2.0.1)](./upgrading_1_5_0)** -- **[Special considerations when upgrading to 2.1.0](./upgrading_2_1_0)** +- **[Special considerations when upgrading to v1.1.0](/administration/upgrading_1_1_0)** +- **[Special considerations when upgrading to v1.1.1](/administration/upgrading_1_1_1)** +- **[Special considerations when upgrading from v1.4.2 to 1.5.x (these considerations also apply when upgrading from 1.4.2 to any version through 2.0.1)](/administration/upgrading_1_5_0)** +- **[Special considerations when upgrading to 2.1.0](/administration/upgrading_2_1_0)** ## Create a backup of your ArchivesSpace instance You should make sure you have a working backup of your ArchivesSpace installation before attempting an upgrade. Follow the steps -under the [Backup and recovery section](./backup) to do this. +under the [Backup and recovery section](/administration/backup) to do this. ## Unpack the new version @@ -127,7 +127,7 @@ Or on Windows: ## If you're using external Solr (required beginning with version 3.2.0) -[Full instructions for using external Solr with ArchivesSpace](../provisioning/solr) +[Full instructions for using external Solr with ArchivesSpace](/provisioning/solr) ## If you've deployed to Tomcat diff --git a/src/content/docs/administration/upgrading_1_1_0.md b/src/content/docs/administration/upgrading_1_1_0.md index 0bfba8d..8588e22 100644 --- a/src/content/docs/administration/upgrading_1_1_0.md +++ b/src/content/docs/administration/upgrading_1_1_0.md @@ -2,7 +2,7 @@ title: Upgrading to 1.1.0 --- -Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](../upgrading) for the standard instructions that apply in all cases. +Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](/administration/upgrading) for the standard instructions that apply in all cases. ## External Solr @@ -17,7 +17,7 @@ AppConfig[:solr_url] = "http://localhost:8090" AppConfig[:public_url] = "http://localhost:8081" ``` -With the introduction of the [optional external Solr instance](../provisioning/solr) functionality this has been updated to: +With the introduction of the [optional external Solr instance](/provisioning/solr) functionality this has been updated to: ``` AppConfig[:backend_url] = "http://localhost:8089" diff --git a/src/content/docs/administration/upgrading_1_1_1.md b/src/content/docs/administration/upgrading_1_1_1.md index b830e88..cf13911 100644 --- a/src/content/docs/administration/upgrading_1_1_1.md +++ b/src/content/docs/administration/upgrading_1_1_1.md @@ -2,7 +2,7 @@ title: Upgrading to 1.1.1 --- -Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](../upgrading) for the standard instructions that apply in all cases. +Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](/administration/upgrading) for the standard instructions that apply in all cases. ## Resequencing of Archival Object & Digital Object Component trees diff --git a/src/content/docs/administration/upgrading_1_5_0.md b/src/content/docs/administration/upgrading_1_5_0.md index 9734dd4..6d7c65c 100644 --- a/src/content/docs/administration/upgrading_1_5_0.md +++ b/src/content/docs/administration/upgrading_1_5_0.md @@ -2,7 +2,7 @@ title: Upgrading to 1.5.0 --- -Additional upgrade considerations specific to this release, which also apply to upgrading from 1.4.2 or lower to any version through 2.0.1. Refer to the [upgrade documentation](./upgrading) for the standard instructions that apply in all cases. +Additional upgrade considerations specific to this release, which also apply to upgrading from 1.4.2 or lower to any version through 2.0.1. Refer to the [upgrade documentation](/administration/upgrading) for the standard instructions that apply in all cases. ## General overview @@ -11,10 +11,10 @@ The upgrade process to the new data model in 1.5.0 requires considerable data tr A quick overview of the steps are: 1. Review this document and understand how the upgrade will impact your data, paying particular attention to the [Preparation section](#preparation) . -2. [Backup your database](./backup). -3. No, really, [backup your database](./backup). -4. It is suggested that [users start with a new solr index](./indexes). To do this, delete the data/solr_index/index directory and all files in the data/indexer_state directory. The embedded version of Solr has been upgraded, which should result in a much more compact index size. -5. Follow the standard [upgrading instructions](./upgrading). Important to note: The setup-database.sh|bat script will modify your database schema, but it will not move the data. If you are currently using the container management plugin you will need to remove it from the list of plugins in your config file prior to starting ArchivesSpace. +2. [Backup your database](/administration/backup). +3. No, really, [backup your database](/administration/backup). +4. It is suggested that [users start with a new solr index](/administration/indexes). To do this, delete the data/solr_index/index directory and all files in the data/indexer_state directory. The embedded version of Solr has been upgraded, which should result in a much more compact index size. +5. Follow the standard [upgrading instructions](/administration/upgrading). Important to note: The setup-database.sh|bat script will modify your database schema, but it will not move the data. If you are currently using the container management plugin you will need to remove it from the list of plugins in your config file prior to starting ArchivesSpace. 6. Start ArchivesSpace. When 1.5.0 starts for the first time, a conversion process will kick off and move the data into the new table structure. **During this time, the application will be unavailable until it completes**. Duration depends on the size of your data and server resources, with a few minutes for very small databases to several hours for very large ones. 7. When the conversion is done, the web application will start and the indexer will rebuild your index. Performance might be slower while the indexer runs, depending on your server environment and available resources. 8. Review the [output of the conversion process](#conversion) following the instructions below. How long it takes for the report to load will depend on the number of entries included in it. @@ -79,7 +79,7 @@ If you have a box and folder associated with a component (or any other hierarchi ## Conversion -When upgrading from 1.4.2 (and earlier versions) to 1.5.0, the container conversion will happen as part of the upgrade process. You will be able to follow its progress in the log. Instructions for upgrading from a previous version of ArchivesSpace are available at [upgrade documentation](./upgrading). +When upgrading from 1.4.2 (and earlier versions) to 1.5.0, the container conversion will happen as part of the upgrade process. You will be able to follow its progress in the log. Instructions for upgrading from a previous version of ArchivesSpace are available at [upgrade documentation](/administration/upgrading). Because this is a major change in the data model for this portion of the application, running at least one test conversion is very strongly recommended. Follow these steps to run the upgrade/conversion process: diff --git a/src/content/docs/administration/upgrading_2_1_0.md b/src/content/docs/administration/upgrading_2_1_0.md index 64889ec..9e76ecc 100644 --- a/src/content/docs/administration/upgrading_2_1_0.md +++ b/src/content/docs/administration/upgrading_2_1_0.md @@ -2,7 +2,7 @@ title: Upgrading to 2.1.0 --- -Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](./upgrading) for the standard instructions that apply in all cases. +Additional upgrade considerations specific to this release. Refer to the [upgrade documentation](/administration/upgrading) for the standard instructions that apply in all cases. :::note These considerations also apply when upgrading to any version past 2.1.0 from a version prior to 2.1.0. diff --git a/src/content/docs/administration/windows.md b/src/content/docs/administration/windows.md index 5cf30b5..1159dc2 100644 --- a/src/content/docs/administration/windows.md +++ b/src/content/docs/administration/windows.md @@ -16,7 +16,7 @@ To add Java to your path, edit you %PATH% environment variable to include the di Environement varialbe be found by "Start" > "Control Panel" , search for environment. Click "edit the system environment variables". In the section System Variables, find the `PATH` environment variable and select it. Click Edit. If the `PATH` environment variable does not exist, click New. In the Edit System Variable (or New System Variable) window, specify the value of the `PATH` environment variable. Click OK. Close all remaining windows by clicking OK. Do the same for `JAVA_HOME` -Before setting up the ArchivesSpace service, you should also [configure ArchivesSpace to run against MySQL](../provisioning/mysql). +Before setting up the ArchivesSpace service, you should also [configure ArchivesSpace to run against MySQL](/provisioning/mysql). Be sure that the MySQL connector jar file is in the lib directory, in order for the service setup script to add it to the application's classpath. diff --git a/src/content/docs/architecture/api.md b/src/content/docs/architecture/api.md index 92a3a0a..73bbf1a 100644 --- a/src/content/docs/architecture/api.md +++ b/src/content/docs/architecture/api.md @@ -3,7 +3,7 @@ title: API --- :::note -See the [API section](../api/index) for more detailed documentation. +See the [API section](/api/index) for more detailed documentation. ::: ## Authentication diff --git a/src/content/docs/architecture/database.md b/src/content/docs/architecture/database.md index 8b71766..1f57f4b 100644 --- a/src/content/docs/architecture/database.md +++ b/src/content/docs/architecture/database.md @@ -4,11 +4,11 @@ title: Database The ArchivesSpace database stores all data that is created within an ArchivesSpace instance. As described in other sections of this documentation, the backend code - particularly the model layer and `ASModel_crud.rb` file - uses the `Sequel` database toolkit to bridge the gap between this underlying data and the JSON objects which are exchanged by the other components of the system. -Often, querying the database directly is the most efficient and powerful way to retrieve data from ArchivesSpace. It is also possible to use raw SQL queries to create custom reports that can be run by users in the staff interface. Please consult the [Custom Reports](../customization/reports) section of this documentation for additional information on creating custom reports. +Often, querying the database directly is the most efficient and powerful way to retrieve data from ArchivesSpace. It is also possible to use raw SQL queries to create custom reports that can be run by users in the staff interface. Please consult the [Custom Reports](/customization/reports) section of this documentation for additional information on creating custom reports. -It is recommended that ArchivesSpace be run against MySQL in production, not the included demo database. Instructions on setting up ArchivesSpace to run against MySQL are [here](../provisioning/mysql). +It is recommended that ArchivesSpace be run against MySQL in production, not the included demo database. Instructions on setting up ArchivesSpace to run against MySQL are [here](/provisioning/mysql). The examples in this section are written for MySQL. There are many freely-available tutorials on the internet which can provide guidance to those unfamiliar with MySQL query syntax and the features of the language. diff --git a/src/content/docs/customization/configuration.md b/src/content/docs/customization/configuration.md index 465a472..3a4d4a8 100644 --- a/src/content/docs/customization/configuration.md +++ b/src/content/docs/customization/configuration.md @@ -17,7 +17,7 @@ ArchivesSpace. Be sure that your new settings are not commented out Set your database name and credentials. The default specifies that the embedded database should be used. It is recommended to use a MySQL database instead of the embedded database. -For more info, see [Using MySQL](../provisioning/mysql) +For more info, see [Using MySQL](/provisioning/mysql) This is an example of specifying MySQL credentials: diff --git a/src/content/docs/customization/plugins.md b/src/content/docs/customization/plugins.md index f0e5a63..6419258 100644 --- a/src/content/docs/customization/plugins.md +++ b/src/content/docs/customization/plugins.md @@ -74,7 +74,7 @@ to the local plugin: plugins/local/frontend/locales/en.yml -More detailed information about overriding locale files is found in [Customizing text in ArchivesSpace](./locales) +More detailed information about overriding locale files is found in [Customizing text in ArchivesSpace](/customization/locales) ## Overriding the visual (web) presentation diff --git a/src/content/docs/customization/theming.md b/src/content/docs/customization/theming.md index 35e4b23..6db53c8 100644 --- a/src/content/docs/customization/theming.md +++ b/src/content/docs/customization/theming.md @@ -106,7 +106,7 @@ This video covers the staff frontend UI, but the same steps can be applied to the public UI as well. Also become a little familiar with the -[build system instructions ](../development/dev) +[build system instructions ](/development/dev) First, pull down a new copy of ArchivesSpace using git and be sure to checkout a tag matching the version you're using or wanting to use. diff --git a/src/content/docs/development/dev.md b/src/content/docs/development/dev.md index fde6088..c6d1002 100644 --- a/src/content/docs/development/dev.md +++ b/src/content/docs/development/dev.md @@ -391,7 +391,7 @@ Or a single example with: ./build/run backend:test -Dexample="does something important" ``` -There are specific instructions and requirements for the [UI tests](./ui_test) to work. +There are specific instructions and requirements for the [UI tests](/development/ui_test) to work. **Advanced: tests and the build directory** @@ -439,8 +439,8 @@ To help make the review go smoothly, here are some general guidelines: ## Building a distribution -See: [Building an Archivesspace Release](./release) for information on building a distribution. +See: [Building an Archivesspace Release](/development/release) for information on building a distribution. ## Generating API documentation -See: [Building an Archivesspace Release](./release) for information on building the documentation. +See: [Building an Archivesspace Release](/development/release) for information on building the documentation. diff --git a/src/content/docs/development/release.md b/src/content/docs/development/release.md index 8faa2e5..18a5206 100644 --- a/src/content/docs/development/release.md +++ b/src/content/docs/development/release.md @@ -204,7 +204,7 @@ Example content: ```md This release requires a **full reindex** of ArchivesSpace for all functionality to work -correctly. Please follow the [instructions for reindexing](https://archivesspace.github.io/tech-docs/administration/indexes.html) +correctly. Please follow the [instructions for reindexing](/administration/indexes) before starting ArchivesSpace with the new version. ``` diff --git a/src/content/docs/development/ui_test.md b/src/content/docs/development/ui_test.md index a52299b..b719824 100644 --- a/src/content/docs/development/ui_test.md +++ b/src/content/docs/development/ui_test.md @@ -105,7 +105,7 @@ Note, however, that some tests are dependent on a sequence of ordered steps and ### Saved pages on spec failures -When frontend specs fail, a screenshot and an html page is saved for each failed example under `frontend/tmp/capybara`. On the CI, a zip file will be available for each failed CI job run under Summary -> Artifacts. In order to load the assets (and not see plain html) when viewing the saved html pages, a dev server should be running locally on port 3000, see [Running a development version of ArchivesSpace](./dev). +When frontend specs fail, a screenshot and an html page is saved for each failed example under `frontend/tmp/capybara`. On the CI, a zip file will be available for each failed CI job run under Summary -> Artifacts. In order to load the assets (and not see plain html) when viewing the saved html pages, a dev server should be running locally on port 3000, see [Running a development version of ArchivesSpace](/development/dev). ### Keeping the test database up to date diff --git a/src/content/docs/migrations/migrate_from_archivists_toolkit.md b/src/content/docs/migrations/migrate_from_archivists_toolkit.md index 716b3cd..a604e59 100644 --- a/src/content/docs/migrations/migrate_from_archivists_toolkit.md +++ b/src/content/docs/migrations/migrate_from_archivists_toolkit.md @@ -16,14 +16,14 @@ These guidelines are for migrating data from Archivists' Toolkit 2.0 Update 16 t - An AT subject record will be set to type 'topical' if it does not have a valid AT type statement or its type is not one of the types in ArchivesSpace. Several other AT LookupList values are not present in ArchivesSpace. These LookupList values cannot be added during the AT migration process and will therefore need to be changed in AT prior to migration. For full details on enum (controlled value list) mappings see the data map. You can use the AT Lookup List tool to change values that will not map correctly, as specified by the data map. - Record audit information (created by, date created, modified by, and date modified) will not migrate from AT to ArchivesSpace. ArchivesSpace will assign new audit data to each record as it is imported into ArchivesSpace. The exception to this is that the username of the user who creates an accession record will be migrated to the accession general note field. -- Implement an ArchivesSpace production version including the setting up of a MySQL database to migrate into. Instructions are included at [Getting Started with ArchivesSpace](../administration/getting_started.html) and [Running ArchivesSpace against MySQL](../provisioning/mysql.html). +- Implement an ArchivesSpace production version including the setting up of a MySQL database to migrate into. Instructions are included at [Getting Started with ArchivesSpace](/administration/getting_started) and [Running ArchivesSpace against MySQL](/provisioning/mysql). ## Preparing for Migrating AT Data - The migration process is iterative in nature. A migration report is generated at the end of each migration routine. The report indicates errors or issues occurring with the migration. (An example of an AT migration report is provided at the end of this document.) You should use this report to determine if any problems observed in the migration results are best remedied in the source data or in the migrated data in the ArchivesSpace instance. If you address the problems in the source data, then you can simply conduct the migration again. - However, once you accept the migration and address problems in the migrated data, you cannot migrate the source data again without establishing a new target ArchivesSpace instance. Migrating data to a previously migrated ArchivesSpace database may result in a great many duplicate record error messages and may cause unrecoverable damage to the ArchivesSpace database. - Please note, data migration can be a very memory and time intensive task due to the large number of records being transferred. As such, we recommend running the AT migration on a computer with at least 2GB of available memory. -- Make sure your ArchivesSpace MySQL database is setup correctly, following the documentation in the ArchivesSpace README file. When creating a MySQL database, you MUST set the default character encoding for the database to be UTF8. This is particularly important if you use a MySQL client, such as Navicat, MySQL Workbench, phpMyAdmin, etc., to create the database. See [Running ArchivesSpace against MySQL](../provisioning/mysql.html) for more details. +- Make sure your ArchivesSpace MySQL database is setup correctly, following the documentation in the ArchivesSpace README file. When creating a MySQL database, you MUST set the default character encoding for the database to be UTF8. This is particularly important if you use a MySQL client, such as Navicat, MySQL Workbench, phpMyAdmin, etc., to create the database. See [Running ArchivesSpace against MySQL](/provisioning/mysql) for more details. - Increase the maximum Java heap space if you are experiencing time out events. To do so: - Stop the current ArchivesSpace instance - Open in a text editor the file "archivesspace.sh" (Linux / Mac OSX) or archivesspace.bat (Windows). The file is located in the ArchivesSpace installation directory. diff --git a/src/content/docs/migrations/migrate_from_archon.md b/src/content/docs/migrations/migrate_from_archon.md index 1ab9110..38b00d3 100644 --- a/src/content/docs/migrations/migrate_from_archon.md +++ b/src/content/docs/migrations/migrate_from_archon.md @@ -92,7 +92,7 @@ Download the latest JAR file release from https://github.com/archivesspace-depre ### Install ArchivesSpace Instance -Implement an ArchivesSpace production version including the setting up of a MySQL database to migrate into. Instructions are included at [Getting Started with ArchivesSpace](../administration/getting_started.html) and [Running ArchivesSpace against MySQL](../provisioning/mysql.html) +Implement an ArchivesSpace production version including the setting up of a MySQL database to migrate into. Instructions are included at [Getting Started with ArchivesSpace](/administration/getting_started) and [Running ArchivesSpace against MySQL](/provisioning/mysql) ### Prepare to Launch Migration diff --git a/src/content/docs/migrations/migration_tools.md b/src/content/docs/migrations/migration_tools.md index ef425aa..337c5ed 100644 --- a/src/content/docs/migrations/migration_tools.md +++ b/src/content/docs/migrations/migration_tools.md @@ -4,7 +4,7 @@ title: Migration tools ## Archivists' Toolkit -- [AT migration tool instructions](migrate_from_archivists_toolkit.html) +- [AT migration tool instructions](/migrations/migrate_from_archivists_toolkit) - [AT migration plugin](https://github.com/archivesspace/at-migration/releases) - [AT migration source code](https://github.com/archivesspace/at-migration) - [AT migration mapping (for 2.x versions of the tool and ArchivesSpace](https://github.com/archivesspace/at-migration/blob/master/docs/ATMappingDocument.xlsx) @@ -16,7 +16,7 @@ title: Migration tools ## Archon -- [Archon migration tool instructions](migrate_from_archon.html) +- [Archon migration tool instructions](/migrations/migrate_from_archon) - [Archon migration tool](https://github.com/archivesspace/archon-migration/releases/latest) - [Archon migration source code](https://github.com/archivesspace/archon-migration/) - [Archon migration mapping (for 2.x versions of the tool and ArchivesSpace)](https://docs.google.com/spreadsheets/d/13soN5djk16QYmRoSajtyAc_nBrNldyL58ViahKFJAog/edit?usp=sharing) diff --git a/src/content/docs/provisioning/domains.md b/src/content/docs/provisioning/domains.md index aefa64b..15bb697 100644 --- a/src/content/docs/provisioning/domains.md +++ b/src/content/docs/provisioning/domains.md @@ -3,7 +3,7 @@ title: Serving over subdomains --- This document describes how to configure ArchivesSpace and your web server to serve the application over subdomains (e.g., `http://staff.myarchive.org/` and `http://public.myarchive.org/`), which is the recommended -practice. Separate documentation is available if you wish to [serve ArchivesSpace under a prefix](prefix.html) (e.g., `http://aspace.myarchive.org/staff` and +practice. Separate documentation is available if you wish to [serve ArchivesSpace under a prefix](/provisioning/prefix) (e.g., `http://aspace.myarchive.org/staff` and `http://aspace.myarchive.org/public`). 1. [Configuring Your Firewall](#Step-1%3A-Configuring-Your-Firewall) diff --git a/src/content/docs/provisioning/solr.md b/src/content/docs/provisioning/solr.md index 2de5922..4746b90 100644 --- a/src/content/docs/provisioning/solr.md +++ b/src/content/docs/provisioning/solr.md @@ -8,7 +8,7 @@ For ArchivesSpace > 3.1.1, external Solr is **required**. For previous versions ## Supported Solr Versions -See the [Solr requirement notes](../administration/getting_started#solr) +See the [Solr requirement notes](/administration/getting_started#solr) ## Install Solr @@ -163,11 +163,11 @@ appears to be correct and will raise an error if not. You can disable this check by setting `AppConfig[:solr_verify_checksums] = false` in `config.rb`. Please note: if you're upgrading an existing installation of ArchivesSpace to use an external Solr, you will need to trigger a full re-index. -See [Indexes](../administration/indexes) for more details. +See [Indexes](/administration/indexes) for more details. --- -You can now follow the instructions in the [Getting started](../administration/getting_started) section to start +You can now follow the instructions in the [Getting started](/administration/getting_started) section to start your ArchivesSpace application. --- @@ -198,4 +198,4 @@ work with the upgraded-to version of Solr. For example the ArchivesSpace Solr v8 will not work as is with Solr v9. After upgrading Solr you should trigger a full re-index. Instructions for this are in -[Indexes](../administration/indexes). +[Indexes](/administration/indexes). diff --git a/src/content/docs/provisioning/tuning.md b/src/content/docs/provisioning/tuning.md index 809b35f..64d28b1 100644 --- a/src/content/docs/provisioning/tuning.md +++ b/src/content/docs/provisioning/tuning.md @@ -3,11 +3,11 @@ title: Performance tuning --- ArchivesSpace is a stack of web applications which may require special tuning in order to run most effectively. This is especially the case for institutions with lots of data or many simultaneous users editing metadata. -Keep in mind that ArchivesSpace can be hosted on multiple server, either in a [multitenant setup](clustering.html) or by deploying the various applications ( i.e. backend, frontend, public, solr, & indexer ) on separate servers. +Keep in mind that ArchivesSpace can be hosted on multiple server, either in a [multitenant setup](/provisioning/clustering) or by deploying the various applications ( i.e. backend, frontend, public, solr, & indexer ) on separate servers. ## Application Settings -The application itself can tuned in numerous ways. It’s a good idea to read the [configuration documentation](../customization/configuration.html), as there are numerous settings that can be adjusted to fit your needs. +The application itself can tuned in numerous ways. It’s a good idea to read the [configuration documentation](/customization/configuration), as there are numerous settings that can be adjusted to fit your needs. An important thing to note is that since ArchivesSpace is a Java application, it’s possible to set the memory allocations used by the JVM. There are numerous articles on the internet full of information about what the optimal settings are, which will depend greatly on the load your server is experiencing and the hardware. It’s a good idea to monitor the application and ensure that it’s not hitting the top limits what you’ve set as the heap. @@ -47,4 +47,4 @@ Keep a close eye on the memory available to the server, as well as your InnoDB b ## Solr -The internet is full of many suggestions on how to optimize a Solr index. [Running an external Solr index](solr.html) can be beneficial to the performance of ArchivesSpace, since that moves the index to its own server. +The internet is full of many suggestions on how to optimize a Solr index. [Running an external Solr index](/provisioning/solr) can be beneficial to the performance of ArchivesSpace, since that moves the index to its own server.