feat: improve schema descriptions

[grantfitzsimmons]

Fixes #8074

This PR is simple. It updates the default schema localization file to populate more useful and accurate table descriptions into the schema for new databases & disciplines!

See https://discourse.specifysoftware.org/t/specify-table-names-and-descriptions/3609

Checklist

• Self-review the PR after opening it to make sure the changes look good and
  self-explanatory (or properly documented)
• Add relevant issue to release milestone

Testing instructions

• Add a new discipline to the database
  • Verify that the new table descriptions are present in the Schema Config
• Create a brand new database
  • Verify that the new table descriptions are present in the Schema Config

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)

• config/common/schema_localization_en.json

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2e5c8774-5d03-4623-8225-3c3b2ba3753f

📥 Commits

Reviewing files that changed from the base of the PR and between 66b1266 and 859cff0.

📒 Files selected for processing (1)

• config/common/schema_localization_en.json

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch issue-8074

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[bhumikaguptaa]

• Add a new discipline to the database
  • Verify that the new table descriptions are present in the Schema Config
• Create a brand new database
  • Verify that the new table descriptions are present in the Schema Config

Works as expected, was able to see all the table descriptions.

[emenslin]

• Add a new discipline to the database
  • Verify that the new table descriptions are present in the Schema Config
• Create a brand new database
  • Verify that the new table descriptions are present in the Schema Config

---

Checked both with adding a new discipline and creating a new database and both had the same issues, I didn't check every table but I checked several and this is what I noticed. I'm not sure if any of these are worth delaying merging but since there are a lot that are different I figured I'd request changes.

• Absolute Age, Component, Collection Object Type, Taxon Attribute, and Tectonic Unit don't have a description. Absolute Age Attachment and Citation, all Relative Age tables, and all other geo related Collection Object tables all contain descriptions.

Several other descriptions don't match the what is said in the table names and descriptions document (https://discourse.specifysoftware.org/t/specify-table-names-and-descriptions/3609)

Geography in specify

• "Represents political boundary (Country, State, County, Township, etc.)."

Geography in the table description document

• "Hierarchical tree representing political boundaries (Country, State, Province, County, Township, etc.). Used to classify localities and agent collecting regions."

Storage in specify

• "A tree data structure for describing where Collection Objects are physically stored."

Storage in table description document

• Hierarchical tree representing the physical storage locations in the collection (e.g., Building > Room > Cabinet > Drawer > Tray). Used to track where Preparations are physically housed."

Taxon in specify

• "Describes the taxonomy of a Determination."

Taxon in table description document

• "Hierarchical tree representing the taxonomic classification of organisms (Kingdom > Phylum > Class > Order > Family > Genus > Species). Used for determinations and organizing collection objects."

[Iwantexpresso]

• Add a new discipline to the database
  • Verify that the new table descriptions are present in the Schema Config
• Create a brand new database
  • Verify that the new table descriptions are present in the Schema Config

jus checked the newest implementation and didn't find any issues with the descriptions I looked at. Nice work!