Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an ADR for indexing policy re: visibility #881

Merged
merged 1 commit into from
Mar 15, 2021
Merged
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
38 changes: 38 additions & 0 deletions architecture-decisions/0007-indexing-visibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 7. Indexing resources with non-public visibility

Date: Archaeological

## Status

Accepted

## Context

Figgy resources may have any of the following visibilities:
- Open (public)
- Princeton (netid)
- On Campus (ip)
- Reading Room
- Private

For each of these we need a policy regarding whether it will be indexed in DPUL.

We used to index only public / complete items. But to support the music reserves
collection we need pages that would have a viewer for logged-in institutional
users only.

## Decision

Resources with the following visibilities should index into DPUL:
- Open (public)
- Princeton (netid)
- On Campus (ip)

This is implemented with a token authentication mechanism in `iiif_resource#def
url`

## Consequences

* Users will see metadata for resources they may not be able to access.
* Users with access will be able to search everything they can view.
* There's no support in DPUL for private or reading room material.