From b789e8412ba4f2c070f8e4768b980d1e9eb1686e Mon Sep 17 00:00:00 2001 From: ldelossa Date: Tue, 14 Jan 2020 12:00:22 -0500 Subject: [PATCH] dot notation to slash, typos, ws, and alt text --- docs/indexer_architecture.md | 6 ++---- docs/vulnerability_matching.md | 14 +++++++------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/indexer_architecture.md b/docs/indexer_architecture.md index 7c6a427d3..c1280118b 100644 --- a/docs/indexer_architecture.md +++ b/docs/indexer_architecture.md @@ -6,14 +6,12 @@ The `Indexer` is implemented as an FSM to correctly report it's current state to ## States The following diagram expresses the possible states of the Indexer -![alt text](./indexer_state_diagram.png "indexer controller state diagram") +![indexer controller state diagram](./indexer_state_diagram.png "indexer controller state diagram") ## Data Model The `Indexer` data model focuses on content addressable hashes as primary keys, the deduplication of package/distribution/repostitory information, and the recording of scan artifacts. Scan artifacts are unique artifacts found within a layer which point to a deduplicated general package/distribution/repository record. The following diagram outlines the current `Indexer` data model. -![alt text](./indexer_data_model.png "indexer data model diagram") - - +![indexer data model diagram](./indexer_data_model.png "indexer data model diagram") diff --git a/docs/vulnerability_matching.md b/docs/vulnerability_matching.md index a645b253b..22df1efaa 100644 --- a/docs/vulnerability_matching.md +++ b/docs/vulnerability_matching.md @@ -9,7 +9,7 @@ Several Scanner interface types exist for extracting contents from container lay ### PackageScanner -`claircore.internal.indexer.PackageScanner` +`claircore/internal/indexer/PackageScanner` ``` type PackageScanner interface { @@ -32,7 +32,7 @@ A PackageScanner implementation should parse a discovered package database withi ### DistributionScanner -`claircore.internal.indexer.PackageScanner` +`claircore/internal/indexer/DistributionScanner` ``` type DistributionScanner interface { @@ -45,7 +45,7 @@ Distribution is typically the base operating system the layer demonstrates featu ### RepositoryScanner (currently not in use) -`claircore.internal.indexer.RepositoryScanner` +`claircore/internal/indexer/RepositoryScanner` ``` type RepositoryScanner interface { @@ -58,7 +58,7 @@ This is currently not implemented however future plans are to match packages wit ## Updater -`claircore.libvuln.driver.Updater` +`claircore/libvuln/driver/Updater` ``` type Updater interface { @@ -70,8 +70,8 @@ type Updater interface { An Updater implementation is responsible for fetching a security advisory database and parsing the contents. An Updater is an aggregate interface consisting of. -`claircore.libvuln.driver.Fetcher` -`claircore.libvuln.driver.Parser` +`claircore/libvuln/driver/Fetcher` +`claircore/libvuln/driver/Parser` ``` type Fingerprint string @@ -98,7 +98,7 @@ In order to run your updater on an interval and as part of the claircore runtime ## Matcher -`claircore.libvuln.driver.Matcher` +`claircore/libvuln/driver/Matcher` ``` type Matcher interface { Name() string