Skip to content

Commit 56337bd

Browse files
authored
Merge pull request #26 from OpenPathfinder/feat/bulk-importer
2 parents e39300e + 821baf1 commit 56337bd

File tree

5 files changed

+26
-4
lines changed

5 files changed

+26
-4
lines changed

docs/projects/visionBoard/checklists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 10
2+
sidebar_position: 11
33
title: Checklists
44
slug: /visionBoard/checklists
55
---

docs/projects/visionBoard/checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 9
2+
sidebar_position: 10
33
title: Checks
44
slug: /visionBoard/Checks
55
---

docs/projects/visionBoard/database_management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 9
33
title: Database Management
44
slug: /visionBoard/database-management
55
---
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
sidebar_position: 7
3+
title: Importers
4+
slug: /visionBoard/importers
5+
---
6+
7+
# Importers
8+
9+
Importers are workflows that allow us to bulk import information from projects directly using the CLI. This is especially useful for registering activity related to [compliance checks](/docs/visionBoard/Checks) that are manually included in the database, such as [softwareDesignTraining](/docs/checks/softwareDesignTraining).
10+
11+
## Bulk Importer
12+
13+
The `bulk-import` workflow streamlines the import process ([reference](https://github.com/OpenPathfinder/visionBoard/pull/182)) and can be used as follows:
14+
15+
```bash
16+
visionBoard workflow run --name bulk-import --file my-data.json
17+
```
18+
19+
20+
### File Format
21+
22+
To initiate the import process, VisionBoard expects a JSON file compliant with [this JSON Schema](https://github.com/OpenPathfinder/visionBoard/blob/main/src/schemas/bulkImport.json).

docs/projects/visionBoard/report_management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 8
33
title: Report Management
44
slug: /visionBoard/report-management
55
---

0 commit comments

Comments
 (0)