artefactual / artefactual/atom-docs
Problem: csv import documentation does not explain the caveats with use of digitalObjectPath
- Dominant language
- Python
- Stars
- 21
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
There are a lot of issues when trying to do CSV imports with the digitalObjectPath column when trying to upload digital objects to records. See the documentation [here](https://www.accesstomemory.org/en/docs/2.10/user-manual/import-export/csv-import/#digital-object-related-import-columns).
It maybe be possible to add caveats in that section, but also in [this section](https://www.accesstomemory.org/en/docs/2.10/user-manual/import-export/csv-import/#):
> In addition to importing new records, AtoM can also attempt to identify matches on existing records and either update them in place, or delete the matches before importing the new records as replacements. This functionality will be described in greater detail below, along with other import options.
And it could instead start with something such as:
> CSV import functionality, especially when replacing records, requires precision and any error in your CSV file risks an error. Errors include XYZ...
Making these caveats clearer will help users encounter less import issues.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked CSV import documentation, especially the digitalObjectPath section and the introductory paragraph covering record replacement and import options. Identify the caveats users need when importing digital objects and replacing records, then update those sections so the risks and limitations are clear to users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100