artefactual / artefactual/atom-docs

Enhancement: add more SQL query examples to documentation

Open
#287 0 comments 2 reactions 0 assignees View on GitHub
admin manual good first issue new content
Dominant language
Python
Stars
21
Forks
31
PR merge metrics
No merged PRs in 30d

Description

## Relevant version

* 2.8; 2.9

## Relevant pages

* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/common-atom-queries/

## Issue description

I am attaching a PDF of SQL queries that I think are useful for AtoM users. These are collected from my personal notes (from client projects or support requests, etc) and from reviewing those threads in the User Forum with the "SQL" and "FAQ" labels to see if anything useful shared there has not yet been added to the docs.

I simply haven't had time to set up a local docs contribution environment, format these notes in reST, and prep a PR. Nevertheless, I did try to make the notes as ready as possible to be added straight to the docs with minimal effort - hopefully making this a decent first / early issue for a new contributor if desired.

For Artefactual staff, here is [a link](https://docs.google.com/document/d/1I7MS13vWQtv94pZeHDUCfBzZTSB4ssbtB02nZRgeLMY/edit) to an internal editable copy.

[AtoM SQL queries for docs (2024-05-03).pdf](https://github.com/artefactual/atom-docs/files/15222783/AtoM.SQL.queries.for.docs.2024-05-03.pdf)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the common AtoM queries page linked in the issue and review the attached PDF of proposed SQL queries. Set up the local documentation contribution environment, format the selected notes in reST, and add them to that page. Done means the useful queries from the source material are integrated into the documentation and the docs build passes.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.