Improve table docs (#19)

Co-authored-by: misraved <[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

@@ -68,6 +68,18 @@ from
 +------------+------------------------------------+--------------+---------------------------+-------------+-----------+--------+------------------+
 ```
 
+## 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/index) | 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/index) | 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/index) | 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:
@@ -107,11 +119,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-mailchimp/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:
 
 - [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
 - [Mailchimp Plugin](https://github.com/turbot/steampipe-plugin-mailchimp/labels/help%20wanted)

docs/index.md

@@ -8,13 +8,14 @@ short_name: "mailchimp"
 description: "Steampipe plugin to query audiences, automation workflows, campaigns, and more from Mailchimp."
 og_description: "Query Mailchimp with SQL! Open source CLI. No DB required."
 og_image: "/images/plugins/turbot/mailchimp-social-graphic.png"
+engines: ["steampipe", "sqlite", "postgres", "export"]
 ---
 
 # Mailchimp + Steampipe
 
-[Mailchimp](https://mailchimp.com) is a marketing automation and email marketing platform.
+[Steampipe](https://steampipe.io) is an open-source zero-ETL engine to instantly query cloud APIs using SQL.
 
-[Steampipe](https://steampipe.io) is an open source CLI to instantly query cloud APIs using SQL.
+[Mailchimp](https://mailchimp.com) is a marketing automation and email marketing platform.
 
 List details of your Mailchimp campaign:
 
@@ -83,8 +84,3 @@ Alternatively, you can also use the standard Mailchimp environment variables to
 ```sh
 export MAILCHIMP_API_KEY=q8355689e3e6f9fd0f5630362b16b1b5-us21
 ```
-
-## Get involved
-
-- Open source: https://github.com/turbot/steampipe-plugin-mailchimp
-- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)

docs/tables/mailchimp_authorized_app.md

@@ -1,12 +1,31 @@
-# Table: mailchimp_authorized_app
+---
+title: "Steampipe Table: mailchimp_authorized_app - Query Mailchimp Authorized Apps using SQL"
+description: "Allows users to query Mailchimp Authorized Apps, providing details about the apps which have been authorized to access a Mailchimp account."
+---
 
-An authorized application is an app that has permission to write or view data in your Mailchimp account.
+# Table: mailchimp_authorized_app - Query Mailchimp Authorized Apps using SQL
+
+Mailchimp Authorized Apps are applications that have been granted permission to access a Mailchimp account. This access is granted by the account owner, and can be revoked at any time. Authorized Apps can perform various actions on the account, limited by the permissions set by the account owner.
+
+## Table Usage Guide
+
+The `mailchimp_authorized_app` table provides insights into the apps authorized to access a Mailchimp account. As an account owner or administrator, you can use this table to manage and monitor app access to your Mailchimp account. It can be used to review app details, including permissions, access levels, and associated metadata.
 
 ## Examples
 
 ### Basic info
+Explore which authorized applications are connected to your Mailchimp account, gaining insights into their names and descriptions for better management and oversight.
 
-```sql
+```sql+postgres
+select
+  id,
+  name,
+  description
+from
+  mailchimp_authorized_app;
+```
+
+```sql+sqlite
 select
   id,
   name,
@@ -16,8 +35,9 @@ from
 ```
 
 ### List users who have linked the app
+Explore which users have connected their accounts with the application, useful for understanding user engagement and app utilization.
 
-```sql
+```sql+postgres
 select
   id,
   name,
@@ -26,4 +46,15 @@ select
 from
   mailchimp_authorized_app,
   jsonb_array_elements_text(users) u;
+```
+
+```sql+sqlite
+select
+  id,
+  name,
+  description,
+  u.value as user
+from
+  mailchimp_authorized_app,
+  json_each(mailchimp_authorized_app.users) as u;
 ```

docs/tables/mailchimp_automation.md

@@ -1,12 +1,34 @@
-# Table: mailchimp_automation
+---
+title: "Steampipe Table: mailchimp_automation - Query Mailchimp Automations using SQL"
+description: "Allows users to query Automations in Mailchimp, specifically the details of each automation, providing insights into email marketing campaigns and their performance."
+---
 
-Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event.
+# Table: mailchimp_automation - Query Mailchimp Automations using SQL
+
+Mailchimp Automations are a feature within the Mailchimp email marketing service that allows users to create and manage automated email campaigns. These campaigns can be set up to trigger based on specific conditions, such as user behavior or predefined schedules. Automations are a powerful tool for enhancing customer engagement and optimizing marketing efforts.
+
+## Table Usage Guide
+
+The `mailchimp_automation` table provides insights into Automations within Mailchimp. As a digital marketer, explore automation-specific details through this table, including campaign settings, trigger events, and associated metadata. Utilize it to uncover information about your email marketing campaigns, such as their status, the number of emails sent, and the performance of each campaign.
 
 ## Examples
 
 ### Basic info
+Explore the details of your email marketing campaigns, such as creation and start times, emails sent, and status, to gain insights into their performance and effectiveness. This can help you strategize and optimize future campaigns.
+
+```sql+postgres
+select
+  id,
+  title,
+  create_time,
+  start_time,
+  emails_sent,
+  status
+from
+  mailchimp_automation;
+```
 
-```sql
+```sql+sqlite
 select
   id,
   title,
@@ -19,8 +41,9 @@ from
 ```
 
 ### Get recipient settings of an automation
+Analyze the settings of an automation to understand the recipient configurations, such as the segment conditions and match options. This can be particularly useful for assessing the efficiency of your automated marketing campaigns.
 
-```sql
+```sql+postgres
 select
   id,
   recipients ->> 'list_id' as recipient_list_id,
@@ -31,9 +54,21 @@ from
   mailchimp_automation;
 ```
 
+```sql+sqlite
+select
+  id,
+  json_extract(recipients, '$.list_id') as recipient_list_id,
+  json_extract(recipients, '$.segment_options.conditions') as recipient_segment_conditions,
+  json_extract(recipients, '$.segment_options.match') as recipient_segment_match,
+  json_extract(recipients, '$.segment_options.saved_segment_id') as saved_segment_id
+from
+  mailchimp_automation;
+```
+
 ### Get settings of an automation
+Analyze the settings to understand the configuration of an automated system. This can be useful in understanding how the system is set up, including aspects such as authentication, auto footer, reply settings, and more.
 
-```sql
+```sql+postgres
 select
   id,
   settings ->> 'authenticate' as authenticate,
@@ -48,9 +83,25 @@ from
   mailchimp_automation;
 ```
 
+```sql+sqlite
+select
+  id,
+  json_extract(settings, '$.authenticate') as authenticate,
+  json_extract(settings, '$.auto_footer') as auto_footer,
+  json_extract(settings, '$.from_name') as from_name,
+  json_extract(settings, '$.inline_css') as inline_css,
+  json_extract(settings, '$.reply_to') as reply_to,
+  json_extract(settings, '$.title') as title,
+  json_extract(settings, '$.to_name') as to_name,
+  json_extract(settings, '$.use_conversation') as use_conversation
+from
+  mailchimp_automation;
+```
+
 ### Get tracking options of an automation
+Determine the tracking options set for an automated email marketing campaign, including various analytics and goal tracking features. This can be useful in understanding how your campaign is performing and which tracking tools are being utilized.
 
-```sql
+```sql+postgres
 select
   id,
   tracking -> 'capsule' ->>'notes' as tracking_capsule_notes,
@@ -69,9 +120,29 @@ from
   mailchimp_automation;
 ```
 
+```sql+sqlite
+select
+  id,
+  json_extract(tracking, '$.capsule.notes') as tracking_capsule_notes,
+  json_extract(tracking, '$.clicktale') as tracking_clicktale,
+  json_extract(tracking, '$.ecomm360') as tracking_ecomm360,
+  json_extract(tracking, '$.goal_tracking') as tracking_goal_tracking,
+  json_extract(tracking, '$.google_analytics') as tracking_google_analytics,
+  json_extract(tracking, '$.highrise.campaign') as tracking_highrise_campaign,
+  json_extract(tracking, '$.highrise.notes') as tracking_highrise_notes,
+  json_extract(tracking, '$.html_clicks') as tracking_html_clicks,
+  json_extract(tracking, '$.opens') as tracking_opens,
+  json_extract(tracking, '$.salesforce.campaign') as tracking_salesforce_campaign,
+  json_extract(tracking, '$.salesforce.notes') as tracking_salesforce_notes,
+  json_extract(tracking, '$.text_clicks') as tracking_text_clicks
+from
+  mailchimp_automation;
+```
+
 ### Get trigger settings of an automation
+Explore the frequency and timing of automated tasks in a mailing system, helping you understand when and how often certain automations occur, such as sending workflow emails. This insight can assist in optimizing your communication strategy.
 
-```sql
+```sql+postgres
 select
   id,
   title,
@@ -82,4 +153,17 @@ select
   trigger_settings ->> 'workflow_type' as trigger_workflow_type
 from
   mailchimp_automation;
+```
+
+```sql+sqlite
+select
+  id,
+  title,
+  json_extract(trigger_settings, '$.runtime.days') as trigger_runtime_days,
+  json_extract(trigger_settings, '$.runtime.hours') as trigger_runtime_hours,
+  json_extract(trigger_settings, '$.workflow_emails_count') as trigger_workflow_emails_count,
+  json_extract(trigger_settings, '$.workflow_title') as trigger_workflow_title,
+  json_extract(trigger_settings, '$.workflow_type') as trigger_workflow_type
+from
+  mailchimp_automation;
 ```