artefactual / artefactual/atom-docs

Problem: documentation missing for new authority record Rename module

Open
#254 0 comments 0 reactions 0 assignees View on GitHub
new content user manual
Dominant language
Python
Stars
21
Forks
31
PR merge metrics
No merged PRs in 30d

Description

**Documentation version**

* 2.8

**Relevant documentation pages**

* https://www.accesstomemory.org/docs/latest/user-manual/add-edit-content/authority-records/

**Issue description**

In 2.8, via [PR1542 in AtoM](https://www.accesstomemory.org/docs/latest/user-manual/add-edit-content/authority-records/), a version of the Rename module initially added for archival descriptions in 2.5 was also added to authority records, so users can edit the slug, title, or associated digital object filename of an authority record.

However, no documentation was added for this feature

**Suggested fix**

Docs should be added to the Authority records documentation page for this new feature. They can be largely based on the existing docs for the desrciptions rename module - see:

* https://www.accesstomemory.org/docs/latest/user-manual/add-edit-content/archival-descriptions/#rename-the-title-or-slug-of-an-archival-description

If you _can_ also edit the filename of an attached DO, then this section could be updated and linked as well:

* https://www.accesstomemory.org/docs/latest/user-manual/import-export/upload-digital-object/#rename-digital-object

It would also make sense to add SEEALSO links to the existing Rename module docs in the description and digital object pages.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the Authority records documentation page and use the archival descriptions Rename module section as the model. Verify whether authority-record digital object filenames can also be renamed, then document editing the slug, title, and applicable filename; add SEEALSO links from the existing description and digital object pages. Done means the new authority-record feature and cross-links are documented accurately.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.