Improve table docs (#23)

Co-authored-by: misraved <[email protected]>
Co-authored-by: Ved misra <[email protected]>

.github/workflows/steampipe-anywhere.yml

@@ -0,0 +1,12 @@
+name: Release Steampipe Anywhere Components
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+
+jobs:
+  anywhere_publish_workflow:
+    uses: turbot/steampipe-workflows/.github/workflows/steampipe-anywhere.yml@main
+    secrets: inherit

README.md

@@ -40,6 +40,18 @@ where
 +-------------+------------------+----------+
 ```
 
+## Engines
+
+This plugin is available for the following engines:
+
+| Engine        | Description
+|---------------|------------------------------------------
+| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
+| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/overview) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
+| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/overview) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
+| [Export](https://steampipe.io/docs/steampipe_export/overview) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
+| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.
+
 ## Developing
 
 Prerequisites:
@@ -79,11 +91,17 @@ Further reading:
 - [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
 - [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
 
-## Contributing
+## Open Source & Contributing
+
+This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
+
+[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
+
+## Get Involved
 
-Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-plugin-pipes/blob/main/LICENSE).
+**[Join #steampipe on Slack →](https://turbot.com/community/join)**
 
-`help wanted` issues:
+Want to help but don't know where to start? Pick up one of the `help wanted` issues:
 
 - [Turbot Pipes Plugin](https://github.com/turbot/steampipe-plugin-pipes/labels/help%20wanted)
 - [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)

docs/index.md

@@ -8,13 +8,14 @@ short_name: "pipes"
 description: "Steampipe plugin for querying workspaces, connections and more from Turbot Pipes."
 og_description: "Query Turbot Pipes with SQL! Open source CLI. No DB required."
 og_image: "/images/plugins/turbot/pipes-social-graphic.png"
+engines: ["steampipe", "sqlite", "postgres", "export"]
 ---
 
 # Turbot Pipes + Steampipe
 
 [Turbot Pipes](https://turbot.com/pipes) is an intelligence, automation & security platform built specifically for DevOps.
 
-[Steampipe](https://steampipe.io) is an open source CLI to instantly query cloud APIs using SQL.
+[Steampipe](https://steampipe.io) is an open-source zero-ETL engine to instantly query cloud APIs using SQL.
 
 For example:
 

docs/tables/pipes_audit_log.md

@@ -1,14 +1,26 @@
-# Table: pipes_audit_log
+---
+title: "Steampipe Table: pipes_audit_log - Query Pipes Audit Logs using SQL"
+description: "Allows users to query Pipes Audit Logs, specifically the logs that capture the activity within the Pipes service, providing insights into user interactions and potential security incidents."
+---
 
-Audit logs record series of events performed on the identity.
+# Table: pipes_audit_log - Query Pipes Audit Logs using SQL
 
-Note: You must specify an organization or user ID, or an organization or user handle, in the where or join clause using the `identity_id` or `identity_handle` columns respectively.
+Pipes Audit Logs is a feature within the Pipes service that records user activity. It provides a comprehensive log of actions taken within the service, including who performed the action, what the action was, and when it was done. Pipes Audit Logs is a critical tool for understanding user behavior, troubleshooting issues, and investigating potential security incidents.
+
+## Table Usage Guide
+
+The `pipes_audit_log` table provides insights into user activity within the Pipes service. As a security analyst or administrator, explore detailed logs through this table, including the actor, action, and timestamp. Utilize it to uncover information about user behavior, troubleshoot issues, and investigate potential security incidents.
+
+**Important Notes**
+
+- You must specify an organization or user ID, or an organization or user handle, in the where or join clause using the `identity_id` or `identity_handle` columns respectively.
 
 ## Examples
 
 ### List audit logs for a user handle
+Discover the actions taken by a particular user by examining their audit logs. This can be useful for analyzing user behavior or investigating potential security issues.
 
-```sql
+```sql+postgres
 select
   id,
   action_type,
@@ -19,9 +31,21 @@ where
   identity_handle = 'myuser';
 ```
 
+```sql+sqlite
+select
+  id,
+  action_type,
+  data
+from
+  pipes_audit_log
+where
+  identity_handle = 'myuser';
+```
+
 ### List audit logs for a user ID
+Explore the actions taken by a specific user by analyzing the audit logs. This can help in understanding user behavior or investigating suspicious activities.
 
-```sql
+```sql+postgres
 select
   id,
   action_type,
@@ -32,9 +56,21 @@ where
   identity_id = 'u_c6fdjke232example';
 ```
 
+```sql+sqlite
+select
+  id,
+  action_type,
+  data
+from
+  pipes_audit_log
+where
+  identity_id = 'u_c6fdjke232example';
+```
+
 ### List audit logs for an organization handle
+Analyze the actions performed in your organization by exploring the audit logs. This can be useful to track changes, identify unusual activity, and maintain security within your organization.
 
-```sql
+```sql+postgres
 select
   id,
   action_type,
@@ -45,9 +81,21 @@ where
   identity_handle = 'myorg';
 ```
 
+```sql+sqlite
+select
+  id,
+  action_type,
+  data
+from
+  pipes_audit_log
+where
+  identity_handle = 'myorg';
+```
+
 ### List audit logs for an organization ID
+Explore which actions have been taken within a specific organization by analyzing its audit logs. This allows you to monitor and understand the operational activities and changes within your organization.
 
-```sql
+```sql+postgres
 select
   id,
   action_type,
@@ -57,3 +105,14 @@ from
 where
   identity_id = 'o_c6qjjsaa6guexample';
 ```
+
+```sql+sqlite
+select
+  id,
+  action_type,
+  data
+from
+  pipes_audit_log
+where
+  identity_id = 'o_c6qjjsaa6guexample';
+```

docs/tables/pipes_connection.md

@@ -1,12 +1,32 @@
-# Table: pipes_connection
+---
+title: "Steampipe Table: pipes_connection - Query Pipes Connections using SQL"
+description: "Allows users to query Pipes Connections, providing insights into the connection details, status, and configuration."
+---
 
-Connections represent a set of tables for a single data source. Each connection is represented as a distinct Postgres schema.
+# Table: pipes_connection - Query Pipes Connections using SQL
+
+Pipes is a service within Steampipe that allows you to create and manage connections between different plugins. It provides a unified interface to set up and manage connections for various plugins, including AWS, Azure, GCP, and more. Pipes help you stay informed about the health and status of your connections and take appropriate actions when predefined conditions are met.
+
+## Table Usage Guide
+
+The `pipes_connection` table provides insights into the connections within Steampipe's Pipes service. As a DevOps engineer, explore connection-specific details through this table, including connection status, configuration, and associated metadata. Utilize it to uncover information about connections, such as those with specific configurations, the health status of connections, and the verification of connection configurations.
 
 ## Examples
 
 ### Basic info
+Explore which plugins are connected to your system and identify any associated handles. This can help you manage your system's connections more effectively.
+
+```sql+postgres
+select
+  id,
+  plugin,
+  handle,
+  identity_handle
+from
+  pipes_connection;
+```
 
-```sql
+```sql+sqlite
 select
   id,
   plugin,
@@ -17,8 +37,9 @@ from
 ```
 
 ### List connections using AWS plugin
+Determine the areas in which AWS plugin is being used for connections. This is useful to understand and manage the distribution and usage of plugins across your connections.
 
-```sql
+```sql+postgres
 select
   id,
   plugin,
@@ -31,9 +52,23 @@ where
   plugin = 'aws';
 ```
 
+```sql+sqlite
+select
+  id,
+  plugin,
+  handle,
+  config,
+  identity_handle
+from
+  pipes_connection
+where
+  plugin = 'aws';
+```
+
 ### List user connections
+Explore which user connections are currently active. This is useful for understanding user engagement and tracking resource usage.
 
-```sql
+```sql+postgres
 select
   id,
   plugin,
@@ -46,9 +81,23 @@ where
   identity_type = 'user';
 ```
 
+```sql+sqlite
+select
+  id,
+  plugin,
+  handle,
+  config,
+  identity_handle
+from
+  pipes_connection
+where
+  identity_type = 'user';
+```
+
 ### List organization workspaces
+Review the configuration of your organization's workspaces to understand the plugins in use and their respective settings. This can help in assessing the elements within your organization's setup and identify areas for optimization or troubleshooting.
 
-```sql
+```sql+postgres
 select
   id,
   plugin,
@@ -60,3 +109,16 @@ from
 where
   identity_type = 'org';
 ```
+
+```sql+sqlite
+select
+  id,
+  plugin,
+  handle,
+  config,
+  identity_handle
+from
+  pipes_connection
+where
+  identity_type = 'org';
+```

docs/tables/pipes_organization.md

@@ -1,12 +1,22 @@
-# Table: pipes_organization
+---
+title: "Steampipe Table: pipes_organization - Query Pipes Organizations using SQL"
+description: "Allows users to query Pipes Organizations. The table provides details such as the organization's name, description, and the date it was created."
+---
+
+# Table: pipes_organization - Query Pipes Organizations using SQL
 
 Users can create their own connections and workspaces, but they are not shared with other users. Organizations, on the other hand, include multiple users and are intended for organizations to collaborate and share workspaces and connections.
 
+## Table Usage Guide
+
+The `pipes_organization` table provides insights into Organizations within Pipes. As a data engineer, explore organization-specific details through this table, including the name, description, and creation date of the organization. Utilize it to uncover information about organizations, such as those with specific data flows, the relationships between organizations, and the verification of data pipelines.
+
 ## Examples
 
 ### Basic info
+Analyze the status of different organizational entities within your system. This is useful to understand the overall health and activity status of various organizations for effective management.
 
-```sql
+```sql+postgres
 select
   id,
   org_id,
@@ -15,3 +25,13 @@ select
 from
   pipes_organization;
 ```
+
+```sql+sqlite
+select
+  id,
+  org_id,
+  org_handle,
+  status
+from
+  pipes_organization;
+```