normalize headings

README.md

@@ -1,5 +1,4 @@
-ArchivesSpace technical documentation
-======================================
+# ArchivesSpace technical documentation
 
 * [Basic administration](./administration)
   * [Getting started](./administration/getting_started.md)

administration/README.md

@@ -1,5 +1,4 @@
-Basic ArchivesSpace administration
-===================================
+# Basic ArchivesSpace administration
 
 * [Getting started](./getting_started.md)
 * [Running ArchivesSpace as a Unix daemon](./unix_daemon.md)

administration/backup.md

@@ -1,7 +1,6 @@
-Backup and recovery
-====================
+# Backup and recovery
 
-# Creating backups using the provided script
+## Creating backups using the provided script
 
 ArchivesSpace provides some simple scripts for backing up a single
 instance to a `.zip` file.  You can run:
@@ -20,7 +19,7 @@ database settings from your configuration file and add a dump of your
 MySQL database to the resulting `.zip` file.
 
 
-# Managing your own backups
+## Managing your own backups
 
 If you want more control over your backups, you can develop your own
 scripts.  ArchivesSpace stores all persistent data in the database, so
@@ -57,7 +56,7 @@ following configuration settings:
      AppConfig[:solr\_backup\_number\_to\_keep] = 1
 
 
-# Recovering from backup
+## Recovering from backup
 
 When recovering an ArchivesSpace installation from backup, you will
 need to restore:
@@ -70,7 +69,7 @@ are worth restoring if you have backups, but they can be recreated
 from scratch if necessary.
 
 
-## Recovering your database
+### Recovering your database
 
 If you are using MySQL, recovering your database just requires loading
 your `mysqldump` backup into an empty database.  If you are using the
@@ -100,7 +99,7 @@ to your ArchivesSpace data directory.  For example:
 
 
 
-## Recovering the search indexes and related indexer files
+### Recovering the search indexes and related indexer files
 
 This step is optional since indexes can be rebuilt from the contents
 of the database.  However, recovering your search indexes can reduce
@@ -130,7 +129,7 @@ For example:
            /path/to/archivesspace/data/
 
 
-## Checking your search indexes
+### Checking your search indexes
 
 ArchivesSpace ships with a script that can run Lucene's CheckIndex
 tool for you, verifying that a given Solr index is free from

administration/getting_started.md

@@ -1,7 +1,6 @@
-Getting started with ArchivesSpace
-===================================
+#Getting started with ArchivesSpace
 
-# System requirements
+## System requirements
 
 * Java 1.7 or 1.8.
 * At least 1024 MB RAM allocated to the application; at least 2 GB for optimal performance.
@@ -16,7 +15,7 @@ MySQL is not required, but is **strongly** recommended for production use.
 any data intended for production, including data in a test instance that you
 intend to move over to a production instance.**
 
-# Getting started
+## Getting started
 
 The quickest way to get ArchivesSpace up and running is to download
 the latest distribution `.zip` file from the following URL:
@@ -49,7 +48,7 @@ written to the file `logs/archivesspace.out` (by default).
 make sure that there are no spaces in any part of the path name in which the
 ArchivesSpace directory is located.
 
-## Start ArchivesSpace
+### Start ArchivesSpace
 
 The first time it starts, the system will take a minute or so to start
 up.  Once it is ready, confirm that ArchivesSpace is running correctly by

administration/indexes.md

@@ -1,5 +1,4 @@
-Re-creating indexes
-====================
+# Re-creating indexes
 
 ArchivesSpace keeps track of what has been indexed by using the files
 under `data/indexer_state`.  If these files are missing, the indexer

administration/passwords.md

@@ -1,5 +1,4 @@
-Resetting passwords
-====================
+# Resetting passwords
 
 Under the `scripts` directory you will find a script that lets you
 reset a user's password.  You can invoke it as:

administration/unix_daemon.md

@@ -1,5 +1,4 @@
-Running ArchivesSpace as a Unix daemon
-========================================
+# Running ArchivesSpace as a Unix daemon
 
 The `archivesspace.sh` startup script doubles as an init script.  If
 you run:

administration/upgrading.md

@@ -1,18 +1,17 @@
-Upgrading to a new release of ArchivesSpace
-============================================
+# Upgrading to a new release of ArchivesSpace
 
 *  **[Special considerations when upgrading to v1.1.1]**
 *  **[Special considerations when upgrading to v1.1.0](./upgrading/UPGRADING_1.1.0.md)**
 *  **[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/UPGRADING_1.5.0.md)**
 *  **[Special considerations when upgrading to 2.1.0](./upgrading/UPGRADING_2.1.0.md)**
 
-# Create a backup of your ArchivesSpace instance
+## 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.md) to do this.
 
-# Unpack the new version
+## Unpack the new version
 
 It's a good idea to unpack a fresh copy of the version of
 ArchivesSpace you are upgrading to.  This will ensure that you are
@@ -33,13 +32,13 @@ For example, on Mac OS X or Linux:
 On Windows, you can do the same by extracting ArchivesSpace into a new
 folder you create in Windows Explorer.
 
-# Shut down your ArchivesSpace instance
+## Shut down your ArchivesSpace instance
 
 To ensure you get a consistent copy, you will need to shut down your
 running ArchivesSpace instance now.
 
 
-# Copy your configuration and data files
+## Copy your configuration and data files
 
 You will need to bring across the following files and directories from
 your original ArchivesSpace installation:
@@ -72,7 +71,7 @@ Note that you may want to preserve the logs file (`logs/archivesspace.out`
 by default) from your previous installation--just in case you need to
 refer to it later.
 
-## Configuration note
+### Configuration note
 
 Sometimes a new release of ArchivesSpace will introduce new
 configuration settings that weren't present in previous releases.
@@ -87,7 +86,7 @@ uncommenting configuration options that won't be in your file if you
 keep your older version.
 
 
-# Transfer your locales data
+## Transfer your locales data
 
 If you've made modifications to you locales file ( en.yml ) with customized
 labels, titles, tooltips, etc., you'll need to transfer those to your new
@@ -104,7 +103,7 @@ new additions in the new version locales files. Simply copy the values you wish
 to keep from your old ArchivesSpace locales to your new ArchivesSpace locales
 files.
 
-# Run the database migrations
+## Run the database migrations
 
 With everything copied, the final step is to run the database
 migrations.  This will apply any schema changes and data migrations
@@ -120,7 +119,7 @@ Or on Windows:
      $ cd archivesspace-1.5.x\archivesspace
      $ scripts\setup-database.bat
 
-# If you're using external Solr
+## If you're using external Solr
 
 It's recommeneded you check your version against the version included with
 ArchivesSpace:
@@ -135,7 +134,7 @@ them if necessary (this is required for proper functionality).
 
 https://github.com/archivesspace/archivesspace/tree/v1.5.x/solr
 
-# If you've deployed to Tomcat
+## If you've deployed to Tomcat
 
 The steps to deploy to Tomcat are esentially the same as in the
 [archivesspace_tomcat](https://github.com/archivesspace/archivesspace_tomcat)
@@ -162,6 +161,6 @@ any libraries from the previous ASpace version from your Tomcat classpath.
         This will copy all the files over to Tomcat.
      9. Start Tomcat
 
-# That's it!
+## That's it!
 
 You can now start your new ArchivesSpace version as normal.

administration/windows.md

@@ -1,5 +1,4 @@
-Running ArchivesSpace as a Windows service
-===========================================
+# Running ArchivesSpace as a Windows service
 
 Running ArchivesSpace as a Windows service requires some additional
 configuration.

architecture/README.md

@@ -1,5 +1,4 @@
-ArchivesSpace architecture and components
-==========================================
+# ArchivesSpace architecture and components
 
 ArchivesSpace is divided into several components: the backend, which
 exposes the major workflows and data types of the system via a

architecture/api.md

@@ -1,7 +1,6 @@
-Working with the ArchivesSpace API
-===================================
+# Working with the ArchivesSpace API
 
-# Authentication
+## Authentication
 
 Most actions against the backend require you to be logged in as a user
 with the appropriate permissions.  By sending a request like:
@@ -16,7 +15,7 @@ authenticated, provide this token with subsequent requests in the
      X-ArchivesSpace-Session: 8e921ac9bbe9a4a947eee8a7c5fa8b4c81c51729935860c1adfed60a5e4202cb
 
 
-# CRUD
+## CRUD
 
 The ArchivesSpace API provides CRUD-style interactions for a number of
 different "top-level" record types.  Working with records follows a

architecture/backend.md

@@ -1,5 +1,4 @@
-The ArchivesSpace backend
-==========================
+# The ArchivesSpace backend
 
 The backend is responsible for implementing the ArchivesSpace API, and
 supports the sort of access patterns shown in the previous section.
@@ -10,7 +9,7 @@ JSON documents produced from instances of JSONModel classes.
 The following sections describe how the backend fits together.
 
 
-# main.rb -- load and initialize the system
+## main.rb -- load and initialize the system
 
 The `main.rb` program is responsible for starting the ArchivesSpace
 system: loading all controllers and models, creating
@@ -52,7 +51,7 @@ the following facilities:
     of each request.
 
 
-# rest.rb -- Request and response handling for REST endpoints
+## rest.rb -- Request and response handling for REST endpoints
 
 The `rest.rb` module provides the mechanism used to define the API's
 REST endpoints.  Each endpoint definition includes:
@@ -96,7 +95,7 @@ time a request reaches the body of an endpoint:
     exception, the transaction will be automatically rolled back.
 
 
-# Controllers
+## Controllers
 
 As touched upon in the previous section, controllers implement the
 functionality of the ArchivesSpace API by registering one or more
@@ -111,7 +110,7 @@ generally don't do much more than coordinate the classes from the
 model layer and send a response back to the client.
 
 
-## crud_helpers.rb -- capturing common CRUD controller actions
+### crud_helpers.rb -- capturing common CRUD controller actions
 
 Even though controllers are quite thin, there's still a lot of overlap
 in their behaviour.  Each record type in the system supports the same
@@ -124,7 +123,7 @@ helper methods that are invoked by each controller, providing methods
 for the standard operations of the system.
 
 
-# Models
+## Models
 
 The backend's model layer is where the action is.  The model layer's
 role is to bridge the gap between the high-level JSONModel objects
@@ -165,7 +164,7 @@ constructed by combining a number of mix-ins (Ruby modules) to satisfy
 the requirements of the given record type.  Features à la carte!
 
 
-## ASModel and other mix-ins
+### ASModel and other mix-ins
 
 At a minimum, every model includes the `ASModel` mix-in, which provides
 base versions of the following methods:
@@ -211,7 +210,7 @@ call to the next mix-in in the chain (eventually reaching ASModel),
 then manipulate the result to implement the desired behaviour.
 
 
-## Nested records
+### Nested records
 
 Some record types, like accessions, digital objects, and subjects, are
 *top-level records*, in the sense that they are created independently
@@ -242,7 +241,7 @@ property of the incoming record.  Each of these date records will be
 automatically linked to the created accession.
 
 
-## Relationships
+### Relationships
 
 A relationship is a link between two top-level records, where the link
 is a separate, dynamically generated, model with zero or more
@@ -292,7 +291,7 @@ appropriate join tables in the database to store this relationship and
 retrieve it later as needed.
 
 
-## Agents and `agent_manager.rb`
+### Agents and `agent_manager.rb`
 
 Agents present a bit of a representational challenge.  There are four
 types of agents (person, family, corporate entity, software), and at a
@@ -334,7 +333,7 @@ This definition sets up the properties of that agent.  It creates:
 
 
 
-# Validations
+## Validations
 
 As records are added to and updated within the ArchivesSpace system,
 they are validated against a number of rules to make sure they are
@@ -376,7 +375,7 @@ validations), while system-level validations are handled by the model
 and the database schema.
 
 
-# Optimistic concurrency control
+## Optimistic concurrency control
 
 Updating a record using the ArchivesSpace API is a two part process:
 
@@ -401,7 +400,7 @@ the latest version before applying their update.
 
 
 
-# The ArchivesSpace permissions model
+## The ArchivesSpace permissions model
 
 The ArchivesSpace backend enforces access control, defining which
 users are allowed to create, read, update, suppress and delete the
@@ -434,7 +433,7 @@ are a member of a group that has been assigned permission to perform
 that action.
 
 
-## Conceptual trickery
+### Conceptual trickery
 
 Since they're repository-scoped, groups govern access to repositories.
 However, there are several record types that exist at the top-level of

architecture/background_jobs.md

@@ -1,5 +1,4 @@
-Background Jobs
-================
+# Background Jobs
 
 ArchivesSpace provides a mechanism for long running processes to run
 asynchronously. These processes are called `Background Jobs`.

architecture/jsonmodel.md

@@ -1,5 +1,4 @@
-JSONModel -- a validated ArchivesSpace record
-==============================================
+# JSONModel -- a validated ArchivesSpace record
 
 The ArchivesSpace system is concerned with managing a number of
 different archival record types.  Each record can be expressed as a
@@ -57,7 +56,7 @@ instances (in JSON format), and much of the user interface's life is
 spent turning forms into JSONModel instances and shipping them off to
 the backend.
 
-# JSONModel::Client -- A high-level API for interacting with the ArchivesSpace backend
+## JSONModel::Client -- A high-level API for interacting with the ArchivesSpace backend
 
 To save the need for a lot of HTTP request wrangling, ArchivesSpace
 ships with a module called JSONModel::Client that simplifies the

architecture/oai-pmh.md

@@ -1,5 +1,4 @@
-OAI-PMH interface
-====================
+# OAI-PMH interface
 
 A starter OAI-PMH interface for ArchivesSpace allowing other systems to harvest
 your records is included in version 2.1.0. Additional features and functionality