atom-docs icon indicating copy to clipboard operation
atom-docs copied to clipboard

Problem: documentation missing for new authority record Rename module

Open fiver-watson opened this issue 1 year ago • 0 comments

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, 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.

fiver-watson avatar Jan 29 '24 19:01 fiver-watson