another 'updating documents'

cdibella · Jul 14, 2015 · c794df3 · c794df3
1 parent ab3ea42
commit c794df3
Show file tree

Hide file tree

Showing 555 changed files with 4,813 additions and 1,677 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,10 @@ Windows (XP, Windows 7, Windows 8, Windows Server 2008 & 2012 ).
 
 MySQL is not required, but is **strongly** recommended for production use.
 
+**The embedded database is for testing purposes only. You should use MySQL for
+any data intended for production, including data in a test instance that you
+intend to move over to a production instance.**
+
 # Getting started
 
 The quickest way to get ArchivesSpace up and running is to download
@@ -257,7 +261,6 @@ and the script will generate a file containing:
 
   * A snapshot of the demo database (if you're using the demo
     database)
-
   * A snapshot of the Solr index and related indexer files
 
 If you are running against MySQL and have `mysqldump` installed, you
@@ -307,7 +310,6 @@ When recovering an ArchivesSpace installation from backup, you will
 need to restore:
 
   * Your database (either the demo database or MySQL)
-
   * The search indexes and related indexer files
 
 Of the two, the database backup is the most crucial--search indexes
@@ -355,14 +357,12 @@ ArchivesSpace indexer:
 
   * solr.backup-[timestamp]/snapshot.[timestamp] -- a snapshot of the
     index files.
-
   * solr.backup-[timestamp]/indexer_state -- the files used by the
     indexer to remember what it last indexed.
 
 To restore these directories from backup:
 
   * Copy your index snapshot to `/path/to/archivesspace/data/solr_index/index`
-
   * Copy your indexer_state backup to `/path/to/archivesspace/data/indexer_state`
 
 For example:

diff --git a/README_PREFIX.md b/README_PREFIX.md
@@ -6,15 +6,12 @@ It's recommended to run each ArchivesSpace instance with its own host name on th
 However, if you are required run ArchivesSpace under a prefix e.g. http://example.com/myarchivesspace, then there will be a few extra steps to your deployment.
 
 1. For the version you're working with, go to the Github repository e.g. http://github.com/archivesspace/archivesspace/tree/v1.0.2 and click the `Download ZIP` button on the right of the screen.  This will download the ArchivesSpace source code to your machine.
-
 2. When you unzip this file it will create a directory containing the source code of the application.  In this directory, create a sub-directory called `config` containing a file `config.rb`.  Edit this file and add the following line(s) with your desired deployment URL including the prefix:
 
      AppConfig[:frontend_url] = "http://example.com/myarchivesspace"
      AppConfig[:public_url] = "http://example.com/mypublicarchivesspace"
-
 3. Open a command prompt and change directory to your unpacked ArchivesSpace directory.  Run the following command:
 
      unix$ build/run dist
      windows> build\run.bat dist
-
 4. This will create a custom ArchivesSpace deployment that will support the prefix you defined.  Follow the Getting Started instructions to deploy this package as normal.
diff --git a/README_TOMCAT.md b/README_TOMCAT.md
@@ -15,23 +15,18 @@ However, if you have a burning desire to use Tomcat, the steps are:
 
   * Download the archivesspace zip distribution, and the Tomcat
     distribution.
-
   * Unpack the archivesspace distribution and modify the
     config/config.rb file to point to your MySQL database (if you're
     using MySQL).  Something like:
 
       AppConfig[:db_url] = "jdbc:mysql://localhost:3306/archivesspace?user=as&password=as123&useUnicode=true&characterEncoding=UTF-8"
-
   * Also in config/config.rb disable embedded solr and set solr url if you want to use an [external Solr instance](README_SOLR.md)
 
       AppConfig[:enable_solr] = false
       AppConfig[:solr_url] = "http://some.solr.org:8983/solr/archivesspace"
-
   * Unpack the Tomcat distribution
-
   * From your 'archivesspace' directory, use the 'configure-tomcat.sh'
     script to copy everything over to your Tomcat directory
-
   * Install the MySQL connector into Tomcat's 'lib' directory.
 
 

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -1,7 +1,7 @@
 # Upgrading to a new release of ArchivesSpace
 
-### Please also see [UPGRADING_1.1.1.md](https://github.com/archivesspace/archivesspace/blob/master/UPGRADING_1.1.1.md)  for special considerations when upgrading to v1.1.1
-### Please also see [UPGRADING_1.1.0.md](https://github.com/archivesspace/archivesspace/blob/master/UPGRADING_1.1.0.md)  for special considerations when upgrading to v1.1.0
+** Please also see [UPGRADING_1.1.1.md](https://github.com/archivesspace/archivesspace/blob/master/UPGRADING_1.1.1.md) for special considerations when upgrading to v1.1.1**
+** Please also see [UPGRADING_1.1.0.md](https://github.com/archivesspace/archivesspace/blob/master/UPGRADING_1.1.0.md) for special considerations when upgrading to v1.1.0**
 
 
 ## Create a backup of your ArchivesSpace instance
@@ -41,11 +41,8 @@ You will need to bring across the following files and directories from
 your original ArchivesSpace installation:
 
   * the `data` directory
-
   * the `config` directory (see **Configuration note** below)
-
   * your `lib/mysql-connector*.jar` file (if using MySQL)
-
   * any plugins and local modifications you have installed in your `plugins` directory
 
 For example, on Mac OS X or Linux:

diff --git a/build/BUILD_README.md b/build/BUILD_README.md
@@ -1,15 +1,15 @@
 ArchivesSpace Build System
 ==========================
 
-# Running the build system
+## Running the build system
 
 To run the build system, use the `build/run` script from your
 ArchivesSpace project directory.  This will display a list of all
 available build tasks.  This document describes a few of the important
 ones.
 
 
-# Bootstrapping
+## Bootstrapping
 
 The bootstrap task:
 
@@ -19,7 +19,7 @@ Will bootstrap your development environment by downloading all
 dependencies--JRuby, Gems, Solr, etc..
 
 
-# Running a development environment
+## Running a development environment
 
 To run a development instance of all ArchivesSpace components:
 
@@ -33,7 +33,7 @@ You can also clear your database and search indexes with:
      build/run db:nuke
 
 
-# Running the tests
+## Running the tests
 
 ArchivesSpace uses a combination of RSpec, integration and Selenium
 tests.  You will need to have Firefox on your path.  Then, to run all
@@ -58,7 +58,7 @@ or a single example with:
      build/run backend:test -Dexample="does something important"
 
 
-# Coverage reports
+## Coverage reports
 
 You can run the coverage reports using:
 
@@ -69,14 +69,14 @@ finishes, produces a set of HTML reports within the `coverage`
 directory in your ArchivesSpace project directory.
 
 
-# Building a distribution
+## Building a distribution
 
 To build an ArchivesSpace release, use the `build_release` script from
 your project directory:
 
      scripts/build_release
 
-# Generating API documentation
+## Generating API documentation
 
 To generate documentation for backend endpoints:
 

diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html
@@ -2,18 +2,18 @@
   <div>
     <!-- <h2>Search</h2> -->
     <div class="searchbox">
-      <form>
-        <input type="text" id="st-search-input" class="searchbox-input" placeholder="Search the docs" />
+      <form onsubmit='google_site_search()'>
+        <input type="text" id="google-search" class="searchbox-input" placeholder="Search the docs" />
       </form>
-      <script type="text/javascript">
-          (function(w,d,t,u,n,s,e){w['SwiftypeObject']=n;w[n]=w[n]||function(){
-            (w[n].q=w[n].q||[]).push(arguments);};s=d.createElement(t);
-            e=d.getElementsByTagName(t)[0];s.async=1;s.src=u;e.parentNode.insertBefore(s,e);
-            })(window,document,'script','//s.swiftypecdn.com/install/v2/st.js','_st');
 
-              _st('install','R97A3uv-TMx4aozWwT1Y','2.0.0');
-            </script>
-
+      <script language="Javascript" type="text/javascript">
+          function google_site_search()
+            {
+                var query = document.getElementById("google-search").value;
+                  window.open("http://google.com/search?q=" + query
+                  + "%20site:" + "http://archivesspace.github.io/archivesspace");
+                  }
+                </script>
     </div>
   </div>
   <!-- <section>
@@ -72,6 +72,7 @@ <h2>Contact</h2>
       <li><a href="https://twitter.com/archivesspace">Twitter</a></li>
       <li><a href="irc://chat.freenode.net/%23archivesspace">IRC</a></li>
       <li><a href="http://github.com/archivesspace">GitHub</a></li>
+      <li><a href="mailto:[email protected]">Email</a></li>
     </ul>
   </section>
   <section>

diff --git a/docs/_site/assets/stylesheets/main.css b/docs/_site/assets/stylesheets/main.css
diff --git a/docs/assets/stylesheets/_top.sass b/docs/assets/stylesheets/_top.sass
diff --git a/docs/assets/stylesheets/_vars.sass b/docs/assets/stylesheets/_vars.sass
@@ -29,7 +29,7 @@ $blue-grey: #8f9ba2
 
 
 $color-text: $grey-dark
-$top-height: 55px
+$top-height: 80px
 $footer-height: 210px
 $footer-bg: #e0e0e0
-$color-link: $grey-dark
+$color-link: $grey-dark
diff --git a/docs/doc/ASConstants.html b/docs/doc/ASConstants.html
@@ -206,7 +206,7 @@ <h3 class="signature first" id="VERSION-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:51 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:02 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASConstants/Repository.html b/docs/doc/ASConstants/Repository.html
@@ -172,7 +172,7 @@ <h3 class="signature first" id="GLOBAL-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:51 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:02 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASDate.html b/docs/doc/ASDate.html
@@ -145,7 +145,7 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href="J
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:54 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASFop.html b/docs/doc/ASFop.html
@@ -644,7 +644,7 @@ <h3 class="signature " id="to_pdf_stream-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:53 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:05 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel.html b/docs/doc/ASModel.html
@@ -424,7 +424,7 @@ <h3 class="signature " id="update_suppressed_flag-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:44 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:55 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/CRUD.html b/docs/doc/ASModel/CRUD.html
@@ -1294,7 +1294,7 @@ <h3 class="signature " id="validate-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:45 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:55 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/CRUD/ClassMethods.html b/docs/doc/ASModel/CRUD/ClassMethods.html
@@ -1317,7 +1317,7 @@ <h3 class="signature " id="update_mtime_for_ids-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:45 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:55 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/DatabaseMapping.html b/docs/doc/ASModel/DatabaseMapping.html
@@ -198,7 +198,7 @@ <h3 class="signature first" id="included-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:49 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:00 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/DatabaseMapping/ClassMethods.html b/docs/doc/ASModel/DatabaseMapping/ClassMethods.html
@@ -302,7 +302,7 @@ <h3 class="signature " id="prepare_for_db-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:49 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:00 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/ModelScoping.html b/docs/doc/ASModel/ModelScoping.html
@@ -467,7 +467,7 @@ <h3 class="signature " id="uri-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:46 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/ModelScoping/ClassMethods.html b/docs/doc/ASModel/ModelScoping/ClassMethods.html
@@ -929,7 +929,7 @@ <h3 class="signature " id="uri_for-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:46 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/RepositoryTransfers.html b/docs/doc/ASModel/RepositoryTransfers.html
@@ -333,7 +333,7 @@ <h3 class="signature first" id="transfer_to_repository-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:47 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/RepositoryTransfers/ClassMethods.html b/docs/doc/ASModel/RepositoryTransfers/ClassMethods.html
@@ -304,7 +304,7 @@ <h3 class="signature " id="transfer_all-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:47 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/SequelHooks.html b/docs/doc/ASModel/SequelHooks.html
@@ -499,7 +499,7 @@ <h3 class="signature " id="before_update-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:46 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASModel/SequelHooks/BlobHack.html b/docs/doc/ASModel/SequelHooks/BlobHack.html
@@ -249,7 +249,7 @@ <h3 class="signature first" id="blob_columns_to_fix-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:46 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASUtils.html b/docs/doc/ASUtils.html
@@ -1219,7 +1219,7 @@ <h3 class="signature " id="wrap-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:51 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:02 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASpaceCoverage.html b/docs/doc/ASpaceCoverage.html
@@ -198,7 +198,7 @@ <h3 class="signature first" id="start-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:51 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:02 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASpaceEnvironment.html b/docs/doc/ASpaceEnvironment.html
@@ -550,7 +550,7 @@ <h3 class="signature " id="prepare_database-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:54 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:46:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASpaceExport.html b/docs/doc/ASpaceExport.html
@@ -701,7 +701,7 @@ <h3 class="signature " id="stream-class_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:46 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:56 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

diff --git a/docs/doc/ASpaceExport/ArchivalObjectDescriptionHelpers.html b/docs/doc/ASpaceExport/ArchivalObjectDescriptionHelpers.html
@@ -775,7 +775,7 @@ <h3 class="signature " id="indexes-instance_method">
 </div>
 
     <div id="footer">
-  ArchivesSpace Version V1.3.0 Documentation Generated on Wed Jul  8 20:10:49 2015 by
+  ArchivesSpace Version v1.3.1-dev10 Documentation Generated on Tue Jul 14 11:45:59 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>