Skip to content

Documentation updates #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# institute-data
# mentorhub-mongodb

This is project contains database configuration, migration scripts, and test data used by the institute system. The Dockerfile creates a mongosh container that connects to a database and runs the scripts to configure the database and load test data.

[Here](https://github.com/orgs/agile-learning-institute/repositories?q=institute&type=all&sort=name) are all of the repositories in the [Institute](https://github.com/agile-learning-institute/institute/tree/main) system
[Here](https://github.com/orgs/agile-learning-institute/repositories?q=mentorHub-&type=all&sort=name) are all of the repositories in the [mentorHub](https://github.com/agile-learning-institute/mentorhub/tree/main) system

## Prerequisits

Expand Down Expand Up @@ -41,7 +41,7 @@ python scrape_engineerkit.py

### Build and test the container

Use the following comand to build and run the container locally. See [here for details](https://github.com/agile-learning-institute/institute/blob/main/docker-compose/README.md) on how to stop/start the database.
Use the following comand to build and run the container locally. See [here for details](https://github.com/agile-learning-institute/mentorHub/blob/main/docker-configurations/README.md) on how to stop/start the database.

```bash
../src/docker/docker-build.sh
Expand All @@ -51,16 +51,3 @@ After that command completes successfully you can verify it worked successfly by

- checking the logs from your institute-mongosh container
- Connect to the database with the Mongo Compass and verify collections and data

## Refactors and Enhancements

- [x] Create more complete test data
- [x] Implement Schema Validation
- [x] Implement Schema Version Migration
- [x] New Schema's and Collections [topics, resources]
- [x] Create Python script to scrape engineerkit markdown
- [ ] Abstract enumeration arrays so they can be used in schema and enumerator data
- [ ] Implement Person transformation in load script (Version Upgrade Logic)
- [ ] Breadcrumbs, define and include type in all schemas
- [ ] Improve URI schema pattern
- [ ] Improve Phone schema pattern
2 changes: 1 addition & 1 deletion src/docker/docker-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ if [ $? -ne 0 ]; then
fi

# Run the Database, API, and UI containers
curl https://raw.githubusercontent.com/agile-learning-institute/mentorhub/main/docker-compose/run-local-db.sh | /bin/bash
/bin/bash =(curl -o - https://raw.githubusercontent.com/agile-learning-institute/mentorhub/main/docker-configurations/run-local.sh) db