Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following is a list of items to take into consideration while building out a Style Guide. Feel free to add notes or make comments on any of it.

...

  • Save the page to be versioned as a child of the current page. The child page will serve as instructions for users operating older versions of ArchivesSpace.

  • Append the title of the child page with the version number of the last relevant version. Use this format: (version x.x.x)

  • Add the following text under the title of the child page: Note: These instructions apply to an earlier release of ArchivesSpace. Please view the Table of Contents to access instructions for the current release. For information about the most current ArchivesSpace release, please visit: https://github.com/archivesspace/archivesspace/releases/latest

  • Append the title of the parent page with the first version the instructions refer to. Use this format: (from vx.x.x)

  • Make your edits to the parent page

  • For an example of a versioned page, see /wiki/spaces/ArchivesSpaceUserManual/pages/1818329113

...

  • Select a page to serve as the ongoing page

  • Copy and paste information from the pages that you want to merge into the ongoing page, then edit the page following the existing editing workflow

  • Once you publish the updated page, write to the Community Engagement Coordinator and ask them to delete the pages that are no longer needed. Provide links to the pages to avoid confusion over which ones to delete.

Linking to ArchivesSpace documentation outside of the Help Center

It’s better to link to information on the ArchivesSace website than to GitHub because Lyrasis/ArchivesSpace team has more control over the pages, but useful information can be found on both sites. Sources for additional information has been compiled on this page: https://archivesspace.org/application/technical-documentation

Content structure

Layout

Consider using Sections and page table of content macro (Possibly consolidate pages, improve navigation?)

...