Skip to content

Commit 378e5f5

Browse files
committed
Updated to reflect new changes
1 parent 4b4d7cc commit 378e5f5

File tree

4 files changed

+17
-35
lines changed

4 files changed

+17
-35
lines changed

demos/02_ingsting-scorecard/02_ingesting-scorecard.mdx

+6-14
Original file line numberDiff line numberDiff line change
@@ -62,31 +62,23 @@ The integration of Scorecard data into the graph involves several steps:
6262
First load some SBOM data into the graph, we can use some test data:
6363

6464
```bash
65-
go run main.go ingest sbom testdata/sboms
65+
minefield ingest sbom testdata/sboms
6666
```
6767

6868
### 2. Load Scorecard Data into the Storage
6969

70-
Then, load the Scorecard data into our storage system using the `load` command. This command processes the JSON files and stores the data for later use.
70+
Then, load the Scorecard data into our storage system using the `graph` command. This command processes the JSON files and stores the data for later use.
7171

7272
```bash
73-
go run main.go ingest scorecard load scorecard_data.json
73+
minefield ingest scorecard graph scorecard_data.json
7474
```
7575

76-
### 3. Graph the Scorecard Data
77-
78-
Next, graph the Scorecard data using the `graph` command. This step integrates the Scorecard data into the graph, establishing relationships between the Scorecard nodes and existing library nodes.
79-
80-
```bash
81-
go run main.go ingest scorecard graph
82-
```
83-
84-
### 4. Cache the Graph
76+
### 3. Cache the Graph
8577

8678
After graphing the data, cache the graph to optimize performance for queries and analyses.
8779

8880
```bash
89-
go run main.go cache
81+
minefield cache
9082
```
9183

9284
### 5. Utilize the Scorecard Data
@@ -98,7 +90,7 @@ With the Scorecard data integrated into the graph, perform queries to extract va
9890
If we want to find all nodes that have a scorecard as their dependency, we can create a leaderboard of the nodes based on the number of dependencies of type scorecard:
9991

10092
```bash
101-
go run main.go leaderboard custom "dependencies scorecard"
93+
minefield leaderboard custom "dependencies scorecard"
10294
```
10395

10496
you should get something similar to:

docs/index.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,12 @@ git clone [email protected]:bitbomdev/minefield.git
4040
cd minefield
4141
```
4242

43-
2. Ingest your SBOM data:
43+
2. Start the service:
44+
```bash
45+
go run main.go start-service
46+
```
47+
48+
3. Ingest your SBOM data:
4449
```bash
4550
go run main.go ingest sbom <sbom_file or sbom_dir>
4651
```
@@ -66,12 +71,6 @@ go run main.go query custom "dependents library pkg:[email protected]"
6671
go run main.go query custom "dependencies library pkg:[email protected] and dependencies library pkg:[email protected]"
6772
```
6873

69-
### Visual Analysis
70-
```bash
71-
# Generate dependency visualizations
72-
go run main.go query custom "dependents library pkg:[email protected]" --visualize
73-
```
74-
7574
### Leaderboard Analytics
7675
```bash
7776
# Generate dependency leaderboards

docs/minefield-cli.md

+3-12
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,10 @@ Flags:
9797

9898
Ingests SBOM data into the graph.
9999

100-
### `minefield ingest osv load <file_or_directory>`
100+
### `minefield ingest osv ingest <file_or_directory>`
101101

102-
Loads [OSV](https://google.github.io/osv.dev/data/#data-dumps) data into local database. Accepts JSON files, directories, or zip files.
103-
104-
### `minefield ingest osv graph`
105-
106-
Loads [OSV](https://google.github.io/osv.dev/data/#data-dumps) data from local database into the graph.
102+
Adds the [OSV](https://google.github.io/osv.dev/data/#data-dumps) data into graph. Accepts JSON files, directories, or zip files.
107103

108104
### `minefield ingest scorecard load <file_or_directory>`
109105

110-
Loads [OpenSSF Scorecard](https://github.com/ossf/scorecard) data into local database. Accepts JSON files, directories, or zip files.
111-
112-
### `minefield ingest scorecard graph`
113-
114-
Loads [OpenSSF Scorecard](https://github.com/ossf/scorecard) data from local database into the graph.
115-
106+
Adds the [OpenSSF Scorecard](https://github.com/ossf/scorecard) data into graph. Accepts JSON files, directories, or zip files.

sidebar-glossary.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ const sidebars: SidebarsConfig = {
77
label: 'Glossary',
88
link: {
99
type: 'generated-index',
10-
title: 'Kubernetes Glossary',
10+
title: 'Minefield Glossary',
1111
description:
12-
'Learn about common Kubernetes and cloud-native terminology',
12+
'Learn more about supply chain security terminology',
1313
slug: '/categories/glossary',
1414
},
1515
items: [

0 commit comments

Comments
 (0)