artefactual / artefactual/atom-docs

Missing: Visible Elements docs do not show newer digital object settings

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

Description

**Documentation version**

* 2.7

**Relevant pages**

* https://www.accesstomemory.org/docs/2.7/user-manual/administer/visible-elements/#hide-or-show-digital-object-metadata-fields

**Description**

* In 2.7, the digital object metadata display area was revised, and a lot of new functionality was added - including separate sections for Preservation metadata (when Archivematica is connected). The Visible elements area for DOs was also expanded significantly, adding one subsection per DO type:

![visible-elements-DO](https://user-images.githubusercontent.com/5068277/231169109-56e292a5-5410-4f8d-a3ac-071808056398.png)

However, currently the documentation does not mention or show (via the related image in the docs) these additional sections. We should update this to clarify.

**Recommended fix**

* Update the screenshot to show all available subsections
* Expand the section documentation to clarify the difference and purpose of each subsection
* Provide mentions and links to related sections, such as:
* [Storage service download configuration settings](https://www.accesstomemory.org/docs/latest/user-manual/administer/settings/#storage-service)
* [Upload and manage digital objects](https://www.accesstomemory.org/docs/latest/user-manual/import-export/upload-digital-object/#upload-digital-object)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the 2.7 Visible Elements documentation page and compare its digital object metadata section with the current 2.7 interface shown in the issue. Update the related screenshot and explain each digital object subsection, including links to storage service settings and digital object uploads. Done means the page documents all available subsections and their purposes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.