Remove instances of "AIID" in repo to prep for federation

ShaurGaur commented 1 year ago

To prepare this repository as a general-purpose "Incident Database" for different federated nodes, removing instances of "AIID" or "AI Incident Database" is a good idea. I looked up all instances of these terms in the current repo to see what changes we'd need. I looked in site/gatsby-site and excluded its .cache, public, blog, contentsubfolders and the .env file. Here's my findings.

AIID= 292 results in 78 files
- AIIDHelmet= 107 results in 29 files
- This is the Helmet component at the top of the page.
- I think we can Ctrl+F and change to “DBHelmet” or something.
- aiidprod = 146 results in 46 files
- Split into two main things.
- aiidprod = 22 results in 13 files
  - Three of these are defining ‘aiidprod’ as the database to query in config.js and gatsby-config.js.
  - The rest query aiidprod explicitly in the translations, migrations and Algolia update scripts.
  - The scripts that query should include config and refer to the db_name in there.
- Aiidprod = 122 results in 34 files
  - These are all the names of GraphQL queries.
  - Could we just remove “Aiidprod” from the name of EVERY GraphQL query? I’m not sure how these names are generated.
- 39 other miscellaneous results
- Some are from the Landing page.
AI Incident Database - 30 results in 20 files
- Some from the Landing page, migrations and translations.
- Others from Cypress integration tests.
- A couple are from components (About, SubmitForm, BibTex, Hero).

I've mentioned this to @smcgregor and @cesarvarela, and there seem to be some easier fixes (such as probably AIIDHelmet) and more difficult fixes.

What should we change these terms to in the codebase? What should we not change?

lmcnulty commented 1 year ago

I would look for places where "AIID" appears in the rendered webpage and isn't configurable. For instance, I believe that above the title of the blog posts, it's hardcoded to say "AIID Blog". It should probably import a value from site/gatsby-site/config.js instead. If you go after those, though, do be careful about translations.

Removing references to the AIID in function names and such is nice to have, but it's a lower priority than user-visible changes. Still, if you want to rename the AIIDHelmet, that would be a simple pull request that could give you practice getting changes into the codebase. I'm not sure about the name "DBHelmet" because that implies that it talks to the database somehow, which it doesn't. It's just a thin wrapper over an imported Helmet, which itself is a wrapper around the HTML <head> element, hence the name. I called in an AIIDHelmet just to make it clear that you weren't supposed to import a Helmet directly. It would be cute if we named it after something that goes over a helmet, like a Visor. Or we could be literal and call it HeadData or just Head.

We could also sidestep this somewhat by making a backronym for "AIID". So, we could declare that the name of the software that the AI Incident Database runs on is something like "Application for Indexing Incidents and Dangers"

cesarvarela commented 1 year ago

@ShaurGaur

Instead of renaming the AIIDHelmet component, this might be a good opportunity to migrate to the new Gatbsy v5 head api.

The aiidprod that you see on every graphQL query comes from the gatsby-source-mongodb plugin that uses the database name to build the query names: allMongodb${databaseName}${collectionName} and changing it would imply changing the data source name on our MongoDB environments, so not easy.

As Luna said, I would start with the user-visible strings, but please remember to split this into small PRs

responsible-ai-collaborative / aiid

Remove instances of "AIID" in repo to prep for federation #1957