artefactual / artefactual/atom

Enhancement: "Draft" publication status option for primary entity types

Open
#2,268 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: enhancement
Dominant language
PHP
Stars
297
Forks
152
Avg merge
1d 8h
Merged PRs (30d)
3

Description

**Issue**

AtoM currently offers the ability to assign a publication status to archival descriptions only, rather than all three primary entity types (archival descriptions, authority records, archival institutions).

I have received feedback about adding this functionality for other entity types as well, most notably authority records. Immediately publishing authority records upon creation potentially raises some issues concerning PII or other information not intended to be publicly available. The ability to switch between "Draft" and "Published" will mitigate these and other similar issues when they crop up.

**Existing workaround**

- Authenticated users with sufficient account privileges can adjust Group permissions for "anonymous" (i.e., unauthenticated/public users) to restrict their access to either all authority records or specific authority records on a more granular level
- PROBLEM: Some key information still appears within search and/or browse results for unauthenticated users

**Suggested enhancement**

- Offer publication status options for authority records especially and also for archival institutions

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by tracing how publication status is implemented for archival descriptions and how authority records and archival institutions appear in search and browse results; done means draft records are excluded from unauthenticated results while authorized users can switch between Draft and Published.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.