Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make all internal links absolute from / #201

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions src/content/docs/about/authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- example.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
<!-- example.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.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/about/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/administration/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/administration/upgrading_1_1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/administration/upgrading_1_1_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/administration/upgrading_1_5_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/administration/upgrading_2_1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/administration/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/architecture/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/architecture/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- .See this [plugin](link-to-plugin) for an example. Also -->

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.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/customization/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/customization/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/customization/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/development/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion src/content/docs/development/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/development/ui_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading