diff --git a/README.md b/README.md index fb3f867..0e527e5 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,13 @@ Additionally, Noodle is reliant on the best source of truth, which is the code i npm install --location=global @noodle-graph/cli ``` -### 2. Add [Noodle comments](https://github.com/noodle-graph/monorepo/packages/scanner/README.md#noodle-comment) +### 2. Add [Noodle comments](https://github.com/noodle-graph/monorepo/blob/master/packages/scanner/README.md#noodle-comment) -[Simple example](https://github.com/noodle-graph/monorepo/examples/basic/someService/index.js) +[Simple example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/someService/index.js) -### 3. Create [config file](https://github.com/noodle-graph/monorepo/packages/cli/README.md#scan-config-file) +### 3. Create [config file](https://github.com/noodle-graph/monorepo/blob/master/packages/cli/README.md#scan-config-file) -[Simple example](https://github.com/noodle-graph/monorepo/examples/basic/noodle.json) +[Simple example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/noodle.json) ### 4. `noodle run --open` @@ -51,7 +51,7 @@ npm install --location=global @noodle-graph/cli noodle run ``` -Using the [scanner](https://github.com/noodle-graph/monorepo/packages/scanner) to search resources relationships and bundles a UI with the results. +Using the [scanner](https://github.com/noodle-graph/monorepo/tree/master/packages/scanner) to search resources relationships and bundles a UI with the results. #### Parameters @@ -66,7 +66,7 @@ Using the [scanner](https://github.com/noodle-graph/monorepo/packages/scanner) t ### Scan config file -You can find example of a config file in the [basic example](https://github.com/noodle-graph/monorepo/examples/basic/noodle.json) +You can find example of a config file in the [basic example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/noodle.json) | Field | Required | Description | |-|-|-| @@ -79,11 +79,11 @@ You can find example of a config file in the [basic example](https://github.com/ | `id` | a-z, number, forward slash, underscore, dash. RegEx: `[a-z\d-_/]+` | Yes | - | Identifier of the resource. | | `name` | Any string | No | The value of `id` | The name of the resource. | | `description` | Any string | No | `null` | Description of the resource. | -| `type` | `null`, `aws/lambda`, `aws/ec2`, `aws/ecs`, `aws/s3`, `aws/sqs`, `aws/sns`, `aws/cloudwatch`, `aws/rds`, `aws/dynamodb`, `aws/elasticache` | No | `null` | The type of the resource is deployed on | +| `type` | See [UI icons](https://github.com/noodle-graph/monorepo/tree/master/packages/ui/public/img) | No | `null` | The type of the resource is deployed on | | `tags` | a-z, number, forward slash, underscore, dash. RegEx: `[a-z\d-_/]+` | No | `[]` | Tags of the resource. For the UI view and filtering. | -| `url` | `null` if `source` is `third-party`, otherwise a valid URL. | Yes, except if `source` is `third-party`. | `null` | The URL of the source to scan. | -| `source` | `github`, `local`, `third-party` | No | `github` if starts with `https://github.com`, `third-party` if `url` is `null`, otherwise `local`. | The type of the source to scan. `third-party` sources won't get scanned. | +| `url` | `null` if `source` is `config`, otherwise a valid URL. | Yes, except if `source` is `config`. | `null` | The URL of the source to scan. | +| `source` | `github`, `local`, `config` | No | `github` if starts with `https://github.com`, otherwise `local`. | The type of the source to scan. `third-party` sources won't get scanned. | ## Contributing -See [CONTRIBUTING.md](https://github.com/noodle-graph/monorepo/CONTRIBUTING.md) +See [CONTRIBUTING.md](https://github.com/noodle-graph/monorepo/blob/master/CONTRIBUTING.md) diff --git a/packages/cli/README.md b/packages/cli/README.md index fb3f867..0e527e5 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -33,13 +33,13 @@ Additionally, Noodle is reliant on the best source of truth, which is the code i npm install --location=global @noodle-graph/cli ``` -### 2. Add [Noodle comments](https://github.com/noodle-graph/monorepo/packages/scanner/README.md#noodle-comment) +### 2. Add [Noodle comments](https://github.com/noodle-graph/monorepo/blob/master/packages/scanner/README.md#noodle-comment) -[Simple example](https://github.com/noodle-graph/monorepo/examples/basic/someService/index.js) +[Simple example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/someService/index.js) -### 3. Create [config file](https://github.com/noodle-graph/monorepo/packages/cli/README.md#scan-config-file) +### 3. Create [config file](https://github.com/noodle-graph/monorepo/blob/master/packages/cli/README.md#scan-config-file) -[Simple example](https://github.com/noodle-graph/monorepo/examples/basic/noodle.json) +[Simple example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/noodle.json) ### 4. `noodle run --open` @@ -51,7 +51,7 @@ npm install --location=global @noodle-graph/cli noodle run ``` -Using the [scanner](https://github.com/noodle-graph/monorepo/packages/scanner) to search resources relationships and bundles a UI with the results. +Using the [scanner](https://github.com/noodle-graph/monorepo/tree/master/packages/scanner) to search resources relationships and bundles a UI with the results. #### Parameters @@ -66,7 +66,7 @@ Using the [scanner](https://github.com/noodle-graph/monorepo/packages/scanner) t ### Scan config file -You can find example of a config file in the [basic example](https://github.com/noodle-graph/monorepo/examples/basic/noodle.json) +You can find example of a config file in the [basic example](https://github.com/noodle-graph/monorepo/blob/master/examples/basic/noodle.json) | Field | Required | Description | |-|-|-| @@ -79,11 +79,11 @@ You can find example of a config file in the [basic example](https://github.com/ | `id` | a-z, number, forward slash, underscore, dash. RegEx: `[a-z\d-_/]+` | Yes | - | Identifier of the resource. | | `name` | Any string | No | The value of `id` | The name of the resource. | | `description` | Any string | No | `null` | Description of the resource. | -| `type` | `null`, `aws/lambda`, `aws/ec2`, `aws/ecs`, `aws/s3`, `aws/sqs`, `aws/sns`, `aws/cloudwatch`, `aws/rds`, `aws/dynamodb`, `aws/elasticache` | No | `null` | The type of the resource is deployed on | +| `type` | See [UI icons](https://github.com/noodle-graph/monorepo/tree/master/packages/ui/public/img) | No | `null` | The type of the resource is deployed on | | `tags` | a-z, number, forward slash, underscore, dash. RegEx: `[a-z\d-_/]+` | No | `[]` | Tags of the resource. For the UI view and filtering. | -| `url` | `null` if `source` is `third-party`, otherwise a valid URL. | Yes, except if `source` is `third-party`. | `null` | The URL of the source to scan. | -| `source` | `github`, `local`, `third-party` | No | `github` if starts with `https://github.com`, `third-party` if `url` is `null`, otherwise `local`. | The type of the source to scan. `third-party` sources won't get scanned. | +| `url` | `null` if `source` is `config`, otherwise a valid URL. | Yes, except if `source` is `config`. | `null` | The URL of the source to scan. | +| `source` | `github`, `local`, `config` | No | `github` if starts with `https://github.com`, otherwise `local`. | The type of the source to scan. `third-party` sources won't get scanned. | ## Contributing -See [CONTRIBUTING.md](https://github.com/noodle-graph/monorepo/CONTRIBUTING.md) +See [CONTRIBUTING.md](https://github.com/noodle-graph/monorepo/blob/master/CONTRIBUTING.md) diff --git a/packages/cli/package.json b/packages/cli/package.json index 00d1eaf..53f7cbe 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -11,6 +11,17 @@ "type": "git", "url": "git+https://github.com/noodle-graph/monorepo.git" }, + "keywords": [ + "noodle", + "graph", + "architecture", + "cli", + "automation", + "ui", + "open-source", + "github", + "scanner" + ], "main": "src/index.js", "bin": { "noodle": "src/index.js" diff --git a/packages/scanner/README.md b/packages/scanner/README.md index 3d175ac..530ec3d 100644 --- a/packages/scanner/README.md +++ b/packages/scanner/README.md @@ -30,7 +30,7 @@ Every time the scanner finds a Noodle comment it will add the relationship to th ### Undeclared resources -Resources that were discovered during the scan and were not listed in the [scan config file](https://github.com/noodle-graph/monorepo/packages/cli/README.md#scan-config-file). +Resources that were discovered during the scan and were not listed in the [scan config file](https://github.com/noodle-graph/monorepo/blob/master/packages/cli/README.md#scan-config-file). ## Scan output @@ -101,7 +101,7 @@ Here is a sample of scan output: } ``` -_Note that this is very similar to the [scan config file](../cli/README.md#scan-config-file), except the `relationships` field_ +_Note that this is very similar to the [scan config file](https://github.com/noodle-graph/monorepo/blob/master/packages/cli/README.md#scan-config-file), except the `relationships` field_ ### Relationship object diff --git a/packages/ui/README.md b/packages/ui/README.md index 0986475..d07c247 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -29,6 +29,6 @@ The graph displayed using [vis.js](https://visjs.org/) under the hood. ## Bundling -The UI must be bundled together with the [scan output](../scanner/README.md#scan-output) to be functional. +The UI must be bundled together with the [scan output](https://github.com/noodle-graph/monorepo/blob/master/packages/scanner/README.md#scan-output) to be functional. -__See the [run command](../cli/README.md#run).__ +__See the [run command](https://github.com/noodle-graph/monorepo/blob/master/packages/cli/README.md#run).__