Skip to content

Commit

Permalink
Add documentation index
Browse files Browse the repository at this point in the history
  • Loading branch information
cesarvarela committed Dec 23, 2024
1 parent 66f63db commit a4d979e
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
6 changes: 1 addition & 5 deletions site/docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,20 +209,16 @@ Restart Gatsby, and you should have a complete working environment!

## MongoDB setup

If the feature you are working on includes structural changes to the MongoDB database or Realm functions, you'll need to create your own project by going to https://cloud.mongodb.com and following these steps:
- Create a new MongoDB project (the free tier will be enough)
- Create a new Atlas cluster with the name: `AIIDDev`
- Choose "Username and Password" as authentication method.
- Choose "My Local Environment" as network access and add your current IP address.
- If your IP is dynamic, add `0.0.0.0` to the list of IP addresses.
- Create a new Realm App. The name should be `AIIDStitch2`. Realm will give it an id like `aiidstitch2-<REALM_APP_ID>`
- Once created, go to `App Settings` and update app region to `Global`
- Create a new database user with admin access and another user with read-only permissions

#### Replicating the Database
Download the latest database backup from https://incidentdatabase.ai/research/snapshots.

Extract the archive, then from the `mongodump` directory, run `mongorestore` (included in [MongoDB tools](https://www.mongodb.com/docs/database-tools/installation/installation)) using the admin user created in the step above to upload the database backup:
Extract the archive, then from the `mongodump` directory, run `mongorestore` (included in [MongoDB tools](https://www.mongodb.com/docs/database-tools/installation/installation)) to upload the database backup:

```
mongorestore mongodb+srv://<USER>:<PASSWORD>@aiiddev.<CLUSTER>.mongodb.net/aiidprod aiidprod
Expand Down
42 changes: 42 additions & 0 deletions site/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# AIID Documentation Index

## Core Documentation

### [Project Overview](../README.md)

Project introduction, contribution guidelines, engineering process, and high-level architecture

### [Application Development Guide](../site/gatsby-site/README.md)

Local development setup, frontend development guide, API documentation, and testing procedures

### [Database Architecture](DATABASE.md)

MongoDB collections structure, schema details, and data relationships

### [Deployment Guide](DEPLOYMENT.md)

Deployment procedures and configuration for Netlify, Prismic, and other services

### [Internationalization Guide](i18N.md)

Internationalization system documentation and translation process

### [Database Migration Guide](MIGRATIONS.md)

Database migration procedures and configuration

### [Configuration Guide](MISC.md)

Additional features including geocoding, user roles, error logging, and build optimization

### [Taxonomy Guide](TAXA.md)

Guide for implementing and managing taxonomies in the system

## Getting Help

- Open issues on [GitHub](https://github.com/responsible-ai-collaborative/aiid/issues)
- Visit the [contact page](https://incidentdatabase.ai/contact)
- Join the project's Slack (link available on contact page)
- Subscribe to the [announcements mailing list](https://groups.google.com/g/incidentsdb)

0 comments on commit a4d979e

Please sign in to comment.