Skip to content

Commit 21da913

Browse files
Merge pull request #34 from agile-learning-institute/documentation-updates
Documentation updates
2 parents 8142a5e + d4c2734 commit 21da913

File tree

2 files changed

+4
-17
lines changed

2 files changed

+4
-17
lines changed

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# institute-data
1+
# mentorhub-mongodb
22

33
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.
44

5-
[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
5+
[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
66

77
## Prerequisits
88

@@ -41,7 +41,7 @@ python scrape_engineerkit.py
4141

4242
### Build and test the container
4343

44-
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.
44+
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.
4545

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

5252
- checking the logs from your institute-mongosh container
5353
- Connect to the database with the Mongo Compass and verify collections and data
54-
55-
## Refactors and Enhancements
56-
57-
- [x] Create more complete test data
58-
- [x] Implement Schema Validation
59-
- [x] Implement Schema Version Migration
60-
- [x] New Schema's and Collections [topics, resources]
61-
- [x] Create Python script to scrape engineerkit markdown
62-
- [ ] Abstract enumeration arrays so they can be used in schema and enumerator data
63-
- [ ] Implement Person transformation in load script (Version Upgrade Logic)
64-
- [ ] Breadcrumbs, define and include type in all schemas
65-
- [ ] Improve URI schema pattern
66-
- [ ] Improve Phone schema pattern

src/docker/docker-build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ if [ $? -ne 0 ]; then
88
fi
99

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

0 commit comments

Comments
 (0)