Skip to content
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

Add importers basic documentation #26

Merged
merged 2 commits into from
Jan 20, 2025
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
2 changes: 1 addition & 1 deletion docs/projects/visionBoard/checklists.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 10
sidebar_position: 11
title: Checklists
slug: /visionBoard/checklists
---
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/visionBoard/checks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 10
title: Checks
slug: /visionBoard/Checks
---
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/visionBoard/database_management.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 8
sidebar_position: 9
title: Database Management
slug: /visionBoard/database-management
---
Expand Down
22 changes: 22 additions & 0 deletions docs/projects/visionBoard/importers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 7
title: Importers
slug: /visionBoard/importers
---

# Importers

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).

## Bulk Importer

The `bulk-import` workflow streamlines the import process ([reference](https://github.com/OpenPathfinder/visionBoard/pull/182)) and can be used as follows:

```bash
visionBoard workflow run --name bulk-import --file my-data.json
```


### File Format

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).
2 changes: 1 addition & 1 deletion docs/projects/visionBoard/report_management.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
title: Report Management
slug: /visionBoard/report-management
---
Expand Down
Loading