Skip to content
Open
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
2 changes: 1 addition & 1 deletion public/customizing_PUI_examples/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
#AppConfig[:solr_params] = { "q.op" => "AND" }
#
## Set the application's language (see the .yml files in
## https://github.com/archivesspace/archivesspace/tree/master/common/locales for
## https://github.com/archivesspace/archivesspace/tree/main/common/locales for
## a list of available locale codes)
#AppConfig[:locale] = :en
#
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/administration/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ If you prefer not to use Docker, another (more involved) way to get ArchivesSpac

ArchivesSpace Docker images are available on the [Docker hub](https://hub.docker.com/u/archivesspace).

- main application images are built from [this Dockerfile](https://github.com/archivesspace/archivesspace/blob/master/Dockerfile)
- solr images are built from [this Dockerfile](https://github.com/archivesspace/archivesspace/blob/master/solr/Dockerfile)
- main application images are built from [this Dockerfile](https://github.com/archivesspace/archivesspace/blob/main/Dockerfile)
- solr images are built from [this Dockerfile](https://github.com/archivesspace/archivesspace/blob/main/solr/Dockerfile)

## Installing

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/administration/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ any libraries from the previous ASpace version from your Tomcat classpath.
6. Run your setup-database script to migration your database.
7. Delete all ASpace related jar libraries in your Tomcat's lib directory. These
will include the "gems" folder, as well as "common.jar" and some
[others](https://github.com/archivesspace/archivesspace/tree/master/common/lib).
[others](https://github.com/archivesspace/archivesspace/tree/main/common/lib).
This will make sure your running the correct version of the dependent
libraries for your new ASpace version.
Just be sure not to delete any of the Apache Tomcat libraries.
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 @@ -27,4 +27,4 @@ The rights statements data model has changed in 2.1.0. If you currently use righ

## For those using an external Solr server

The index schema has changed with 2.1.0. If you are using an external Solr server, you will need to update the [schema.xml](https://github.com/archivesspace/archivesspace/blob/master/solr/schema.xml) with the newer version. If you are using the default Solr index that ships with ArchivesSpace, no action is needed.
The index schema has changed with 2.1.0. If you are using an external Solr server, you will need to update the [schema.xml](https://github.com/archivesspace/archivesspace/blob/main/solr/schema.xml) with the newer version. If you are using the default Solr index that ships with ArchivesSpace, no action is needed.
6 changes: 3 additions & 3 deletions src/content/docs/architecture/public.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ file, with the relevant configuration options are prefixed with
`:pui_`.

To see the full list of available options, see the file
[`https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb`](https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb)
[`https://github.com/archivesspace/archivesspace/blob/main/common/config/config-defaults.rb`](https://github.com/archivesspace/archivesspace/blob/main/common/config/config-defaults.rb)

### Preserving Patron Privacy

Expand Down Expand Up @@ -116,7 +116,7 @@ Also, it is advised to inherit this element in a composite fashion once it is de
- Scope and contents note (indirect inheritance)
- Language of Materials note (indirect inheritance, but there seems to be a bug right now so that the Language notes always show up as being directly inherited. See AR-XXXX)

See https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb#L296-L396 for more information and examples.
See https://github.com/archivesspace/archivesspace/blob/main/common/config/config-defaults.rb#L296-L396 for more information and examples.

Also, a video overview of this feature, which was recorded before development was finished, is available online:
https://vimeo.com/195457286
Expand Down Expand Up @@ -151,4 +151,4 @@ When you set include_level to true, that means the archival object level will be

ArchivesSpace is released under the [Educational Community License,
version 2.0](http://opensource.org/licenses/ecl2.php). See the
[COPYING](https://github.com/archivesspace/archivesspace/blob/master/COPYING) file for more information.
[COPYING](https://github.com/archivesspace/archivesspace/blob/main/COPYING) file for more information.
2 changes: 1 addition & 1 deletion src/content/docs/customization/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ AppConfig[:solr_params] = {
#### `AppConfig[:locale]`

Set the application's language (see the .yml files in
https://github.com/archivesspace/archivesspace/tree/master/common/locales
https://github.com/archivesspace/archivesspace/tree/main/common/locales
for a list of available locale codes). Default is English (:en):

`AppConfig[:locale] = :en`
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/customization/locales.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ application may then add to or override these values with their own locales file

For a guide on managing these "i18n" files, please visit http://guides.rubyonrails.org/i18n.html

You can see the source files for both the [Staff Frontend Application](https://github.com/archivesspace/archivesspace/tree/master/frontend/config/locales) and
[Public Application](https://github.com/archivesspace/archivesspace/tree/master/public/config/locales). There is also a [common locale file](https://github.com/archivesspace/archivesspace/blob/master/common/locales/en.yml) for some values used throughout the ArchivesSpace applications.
You can see the source files for both the [Staff Frontend Application](https://github.com/archivesspace/archivesspace/tree/main/frontend/config/locales) and
[Public Application](https://github.com/archivesspace/archivesspace/tree/main/public/config/locales). There is also a [common locale file](https://github.com/archivesspace/archivesspace/blob/main/common/locales/en.yml) for some values used throughout the ArchivesSpace applications.

The base translations are broken up:

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 @@ -10,7 +10,7 @@ Plugins provide a mechanism to customize ArchivesSpace by overriding or extendin
without changing the core codebase. As they are self-contained, they also permit the ready
sharing of packages of customization between ArchivesSpace instances.

The ArchivesSpace distribution comes with the `hello_world` exemplar plugin. Please refer to its [README file](https://github.com/archivesspace/archivesspace/blob/master/plugins/hello_world/README.md) for a detailed description of how it is constructed and implemented.
The ArchivesSpace distribution comes with the `hello_world` exemplar plugin. Please refer to its [README file](https://github.com/archivesspace/archivesspace/blob/main/plugins/hello_world/README.md) for a detailed description of how it is constructed and implemented.

You can find other examples in the following plugin repositories. The ArchivesSpace plugins that are officially supported and maintained by the ArchivesSpace Program Team are in archivesspace-plugins (https://github.com/archivesspace-plugins). Deprecated code which is no longer supported but has been kept for future reference is in archivesspace-deprecated (https://github.com/archivesspace-deprecated). There is an open/unmanaged GitHub repository where community members can share their code called archivesspace-labs (https://github.com/archivesspace-labs). The community developed Python library for interacting with the ArchivesSpace API, called ArchivesSnake, is managed in the archivesspace-labs repository.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/development/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ requirements are:
- dev Solr, localhost:8983 create archivesspace core using ArchivesSpace configuration
- test Solr, localhost:8984, create archivesspace core using ArchivesSpace configuration

The defaults can be changed using [environment variables](https://github.com/archivesspace/archivesspace/blob/master/build/build.xml#L43-L46) located in the build file.
The defaults can be changed using [environment variables](https://github.com/archivesspace/archivesspace/blob/main/build/build.xml#L43-L46) located in the build file.

### Download the MySQL connector

Expand Down
16 changes: 8 additions & 8 deletions src/content/docs/development/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ git checkout release-v1.0.x

Patch versions typically arise because a regression or critical bug has arisen since
the last major or minor release. We try to ensure that the "hotfix" is merged into both
master and the release branch without the need to cherry-pick commits from one branch to
main and the release branch without the need to cherry-pick commits from one branch to
the other. The reason is that cherry-picking creates a new commit (with a new commit id)
that contains identical changes, which is not optimal for the repository history.

It is therefore preferable to start from the release branch when creating a "hotfix"
that needs to be merged into both the release branch and master. The Pull Request should
that needs to be merged into both the release branch and main. The Pull Request should
then be based on the release branch. After that Pull Request has been through Code review,
QA and merged, a second Pull Request should be created to merge the updated release branch
to master.
to main.

Consider the following scenario. The current production release is v1.0.0 and a critical
bug has been discovered. In the time since v1.0.0 was released, new features have been
added to the master branch, intended for release in v1.1.0:
added to the main branch, intended for release in v1.1.0:

```shell
git checkout -b oh-no-some-migration-corrupts-some-data origin/release-v1.0.0
Expand All @@ -59,8 +59,8 @@ gh pr create -B release-v1.0.x --web
git checkout release-v1.0.x
git pull
git tag v1.0.1
gh pr create -B master --web
( PR is reviewed and merged to the master branch)
gh pr create -B main --web
( PR is reviewed and merged to the main branch)
```

## Pre-release steps
Expand All @@ -70,7 +70,7 @@ gh pr create -B master --web
Before proceeding further, it’s a good idea to check that there aren’t missing
translations or multiple gem versions.

1. Bootstrap your current development environment on the latest master branch
1. Bootstrap your current development environment on the latest main branch
by downloading all dependencies--JRuby, Gems, Solr, etc.

```shell
Expand Down Expand Up @@ -137,7 +137,7 @@ percentage of the code and are not especially useful.

### Commit built docs and push to Github pages

1. Double check that you are on a release branch (we don't need this stuff in master) and
1. Double check that you are on a release branch (we don't need this stuff in main) and
commit the newly built documentation:

```shell
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/development/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Using the VS Code editor
description: Instructions for using the VS Code editor with ArchiveSpace, including prerequisites and setup.
---

ArchivesSpace provides a [VS Code settings file](https://github.com/archivesspace/archivesspace/blob/master/.vscode/settings.json) that makes it easy for contributors using VS Code to follow the code style of the project. Using this tool chain in your editor helps fix code format and lint errors _before_ committing files or running tests. In many cases such errors will be fixed automatically when the file being worked on is saved. Errors that can't be fixed automatically will be highlighted with squiggly lines. Hovering your cursor over these lines will display a description of the error to help reach a solution.
ArchivesSpace provides a [VS Code settings file](https://github.com/archivesspace/archivesspace/blob/main/.vscode/settings.json) that makes it easy for contributors using VS Code to follow the code style of the project. Using this tool chain in your editor helps fix code format and lint errors _before_ committing files or running tests. In many cases such errors will be fixed automatically when the file being worked on is saved. Errors that can't be fixed automatically will be highlighted with squiggly lines. Hovering your cursor over these lines will display a description of the error to help reach a solution.

## Prerequisites

Expand Down Expand Up @@ -36,7 +36,7 @@ Run the following command from the ArchivesSpace root directory.
npm install
```

See [package.json](https://github.com/archivesspace/archivesspace/blob/master/package.json) for further details on how these tools are used in ArchivesSpace.
See [package.json](https://github.com/archivesspace/archivesspace/blob/main/package.json) for further details on how these tools are used in ArchivesSpace.

### Add VS Code extensions

Expand All @@ -47,6 +47,6 @@ Add the following extensions via the VS Code command palette or the Extensions p
3. [Ruby Rubocop Revised](https://marketplace.visualstudio.com/items?itemName=LoranKloeze.ruby-rubocop-revived) (LoranKloeze.ruby-rubocop-revived)
4. [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) (stylelint.vscode-stylelint)

It's important to note that since these extensions work in tandem with the [VS Code settings file](https://github.com/archivesspace/archivesspace/blob/master/.vscode/settings.json), these settings only impact your ArchivesSpace VS Code Workspace, not your global VS Code User settings.
It's important to note that since these extensions work in tandem with the [VS Code settings file](https://github.com/archivesspace/archivesspace/blob/main/.vscode/settings.json), these settings only impact your ArchivesSpace VS Code Workspace, not your global VS Code User settings.

The extensions should now work out of the box at this point providing error messages and autocorrecting fixable errors on file save!
10 changes: 5 additions & 5 deletions src/content/docs/migrations/migration_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ description: Links to tools for migrating data into and out of ArchivesSpace.
## Data Import and Export Maps

- [Accession CSV Map](http://archivesspace.org/wp-content/uploads/2016/05/Accession-CSV-mapping-2013-08-05.xlsx)
- [Accession CSV Template](https://github.com/archivesspace/archivesspace/tree/master/templates)
- [Archival Objects from Excel or CSV with Load Via Spreadsheet](https://github.com/archivesspace/archivesspace/tree/master/templates)
- [Assessment CSV Template](https://github.com/archivesspace/archivesspace/tree/master/templates)
- [Accession CSV Template](https://github.com/archivesspace/archivesspace/tree/main/templates)
- [Archival Objects from Excel or CSV with Load Via Spreadsheet](https://github.com/archivesspace/archivesspace/tree/main/templates)
- [Assessment CSV Template](https://github.com/archivesspace/archivesspace/tree/main/templates)
- [Digital Object CSV Map](http://archivesspace.org/wp-content/uploads/2016/08/DigitalObject-CSV-mapping-2013-02-26.xlsx)
- [Digital Object CSV Template](https://github.com/archivesspace/archivesspace/tree/master/templates)
- [Digital Object CSV Template](https://github.com/archivesspace/archivesspace/tree/main/templates)
- [Digital Objects Export Maps](http://archivesspace.org/wp-content/uploads/2016/08/ASpace-Dig-Object-Exports.xlsx)
- [EAD Import / Export Map](https://archivesspace.org/wp-content/uploads/2021/06/EAD-Import-Export-Mapping-20171030.xlsx)
- [Location Record CSV Template](https://github.com/archivesspace/archivesspace/tree/master/templates)
- [Location Record CSV Template](https://github.com/archivesspace/archivesspace/tree/main/templates)
- (newly reviewed) [MARCXML Import Map](https://archivesspace.org/wp-content/uploads/2021/06/AS-MARC-import-mappings-2021-06-15.xlsx)
- [MARCXML Export Map](https://archivesspace.org/wp-content/uploads/2021/06/MARCXML-Export-Mapping-20130715.xlsx)
- [MARCXML Authority Import / Export Map](https://archivesspace.org/wp-content/uploads/2021/05/Agents-ASpace-to-MARCXMLMay2021.xlsx)
Expand Down