Diagram is available at:
https://drive.google.com/file/d/0BwgPHAjIDESYSlFpQlpCaGU0bEk/view?usp=sharing
(To view the full size chart click “Open” at the top; you will have to enable the Draw.Io app to access your Google Drive account.)
Notes:
- ArchivesSpace website links to GitHub.io for primary documentation
- Sourced from GitHub.com source code
- There are some places that link directly to the GitHub.com source documentation instead of the GitHub.io version.
- Confusing for users who will think these are two different documentation sites, plus GitHub.com sometimes links to different content than GitHub.io.
- If someone stumbles on the GitHub.com version because they’re looking at the source code, that’s fine, but we should try to avoid linking there directly (unless linking to actual code)
- Overview of diagram:
- Top and left yellow boxes are sections of main GitHub.com readme. Right hand yellow boxes have their own GitHub.com pages.
- Yellow boxes with thick borders are mirrored on GitHub.io. If a bolded box has no arrow pointing to it, we are good (it means the content is available on GitHub.io and no one is linking to the GitHub.com version).
- Places that link to GitHub.com (represented by arrows going to the yellow boxes)
- AS website top menu
- System requirements
- Getting started
- Contributor License Agreement (links to directory of GitHub files – pretty ugly)
- GitHub.io version
- Has internal links to GitHub.com version instead of its own (represented by red arrows):
- Running AS a Windows Service (links to Tomcat and Mysql)
- Upgrading to new release (links to main GitHub.com version of documentation and Tomcat)
- Has internal links to GitHub.com version instead of its own (represented by red arrows):
- AS website top menu
- Orphaned GitHub.com content?
- Yellow boxes with thin borders represent GitHub.com documentation that did not appear to be mirrored on GitHub.io version
- Most of these have no arrows to them, i.e. nothing appears to be linking to them.
- Should be reviewed to see if they need to be kept, and if so, where they should be linked from.
- Mismatched content (red border):
- Running under a prefix
- GitHub.io and GitHub.com both have pages titled “Running ArchivesSpace under a prefix”, but content is different
- Plugins and local customizations
- GitHub.com has two Plugins docs: one is a section of the main readme, the other is a separate page.
- Only the separate page is mirrored on GitHub.io, section of readme should be deleted?
- Running under a prefix
- Broken links: