From 534dbfb8028c9a46e1a674d786ceec97e7d7a64f Mon Sep 17 00:00:00 2001 From: Karan Popat Date: Thu, 18 Apr 2024 18:23:32 +0530 Subject: [PATCH] fix broken link (#191) --- docs/reference/config-files/workspace.md | 2 +- docs/reference/mod-resources/category.md | 2 +- docs/reference/mod-resources/image.md | 6 +++--- docs/steampipe_postgres/configure.md | 4 ++-- docs/steampipe_sqlite/configure.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/reference/config-files/workspace.md b/docs/reference/config-files/workspace.md index 5eefb19..9def796 100644 --- a/docs/reference/config-files/workspace.md +++ b/docs/reference/config-files/workspace.md @@ -60,7 +60,7 @@ Any unset arguments will assume the default values. | `mod_location` | The current working directory | Set the workspace working directory.

Env: [STEAMPIPE_MOD_LOCATION](/docs/reference/env-vars/steampipe_mod_location)
CLI: `--mod-location` | `options` | | An options block to set command-specific options for this workspace. [Query](#steampipe-query-options), [check](#steampipe-check-options), and [dashboard](#steampipe-dashboard-options) options are supported. | `pipes_host` | `pipes.turbot.com` | Set the Turbot Pipes host for connecting to Turbot Pipes workspace.

Env: [PIPES_HOST](/docs/reference/env-vars/pipes_host)
CLI: `--pipes-host` -| `pipes_token` | The token obtained by `steampipe login` | Set the Turbot Pipes authentication token for connecting to a Turbot Pipes workspace. This may be a token obtained by `steampipe login` or a user-generated [token](https://turbot.com/pipes/docs/profile#tokens).

Env: [PIPES_TOKEN](/docs/reference/env-vars/pipes_TOKEN)
CLI: `--pipes-token` +| `pipes_token` | The token obtained by `steampipe login` | Set the Turbot Pipes authentication token for connecting to a Turbot Pipes workspace. This may be a token obtained by `steampipe login` or a user-generated [token](https://turbot.com/pipes/docs/profile#tokens).

Env: [PIPES_TOKEN](/docs/reference/env-vars/pipes_token)
CLI: `--pipes-token` | `progress` | `true` | Enable or disable progress information.

CLI: `--progress` | `query_timeout` | `240` for controls, unlimited otherwise | The maximum time (in seconds) a query is allowed to run before it times out.

Env: [STEAMPIPE_QUERY_TIMEOUT](/docs/reference/env-vars/steampipe_query_timeout)
CLI: `--query_timeout` | `search_path` | `public`, then alphabetical | A comma-separated list of connections to use as a custom search path for the control run. See also: [Using search_path to target connections and aggregators](https://steampipe.io/docs/guides/search-path).

CLI: `--search-path` diff --git a/docs/reference/mod-resources/category.md b/docs/reference/mod-resources/category.md index 4f0e614..c1bcfb4 100644 --- a/docs/reference/mod-resources/category.md +++ b/docs/reference/mod-resources/category.md @@ -143,7 +143,7 @@ category "iam_policy" { |-|-|-|- | `color` | String | The matching color from the default theme for the data series index. | A [valid color value](reference/mod-resources/dashboard#color). This may be a named color, RGB or RGBA string, or a control status color. | The color to display for this category. | | `href` | String | Optional | A url that the item should link to. The `href` may use a [jq template](reference/mod-resources/dashboard#jq-templates) to dynamically generate the link. | -| `icon` | String | Optional | An [icon]((reference/mod-resources/dashboard#icon)) to use for the elements with this category. +| `icon` | String | Optional | An [icon](reference/mod-resources/dashboard#icon) to use for the elements with this category. | `title` | String | Optional | A plain text [title](/docs/reference/mod-resources/dashboard#title) to display for this category. | `fold` | Block | Optional | A `fold` block for this category. diff --git a/docs/reference/mod-resources/image.md b/docs/reference/mod-resources/image.md index 23f6934..5c19fd9 100644 --- a/docs/reference/mod-resources/image.md +++ b/docs/reference/mod-resources/image.md @@ -56,9 +56,9 @@ Simple data structure: Formal data structure: -| src | alt | -| ------------------------------------ | -------------- | -| https://steampipe.io/images/logo.png | Steampipe Logo | +| src | alt | +| ---------------------------------------------- | -------------- | +| https://steampipe.io/images/steampipe-logo.png | Steampipe Logo | ## More Examples diff --git a/docs/steampipe_postgres/configure.md b/docs/steampipe_postgres/configure.md index 84f260a..ed0257d 100644 --- a/docs/steampipe_postgres/configure.md +++ b/docs/steampipe_postgres/configure.md @@ -141,13 +141,13 @@ DROP EXTENSION IF EXISTS steampipe_postgres_aws CASCADE; ``` ## Caching -By default, query results are cached for 5 minutes. You can change the duration with the [STEAMPIPE_CACHE_MAX_TTL](docs/reference/env-vars/steampipe_cache_max_ttl): +By default, query results are cached for 5 minutes. You can change the duration with the [STEAMPIPE_CACHE_MAX_TTL](/docs/reference/env-vars/steampipe_cache_max_ttl): ```bash export STEAMPIPE_CACHE_MAX_TTL=600 # 10 minutes ``` -or disable caching with the [STEAMPIPE_CACHE](docs/reference/env-vars/steampipe_cache): +or disable caching with the [STEAMPIPE_CACHE](/docs/reference/env-vars/steampipe_cache): ```bash export STEAMPIPE_CACHE=false ``` diff --git a/docs/steampipe_sqlite/configure.md b/docs/steampipe_sqlite/configure.md index 526176d..bdd14ac 100644 --- a/docs/steampipe_sqlite/configure.md +++ b/docs/steampipe_sqlite/configure.md @@ -95,13 +95,13 @@ $ sqlite3 :memory: 'select * from pragma_compile_options()' | grep OMIT_LOAD_EXT ## Caching -By default, query results are cached for 5 minutes. You can change the duration with the [STEAMPIPE_CACHE_MAX_TTL](docs/reference/env-vars/steampipe_cache_max_ttl): +By default, query results are cached for 5 minutes. You can change the duration with the [STEAMPIPE_CACHE_MAX_TTL](/docs/reference/env-vars/steampipe_cache_max_ttl): ```bash export STEAMPIPE_CACHE_MAX_TTL=600 # 10 minutes ``` -or disable caching with the [STEAMPIPE_CACHE](docs/reference/env-vars/steampipe_cache): +or disable caching with the [STEAMPIPE_CACHE](/docs/reference/env-vars/steampipe_cache): ```bash export STEAMPIPE_CACHE=false ```