Use command sfdx hardis:doc:plugin:generate to generate Github pages documentation

.github/workflows/build-deploy-docs.yml

@@ -0,0 +1,28 @@
+name: "DOC - Build and deploy with sfdx-hardis"
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  # Build & deploy docs
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      # Build doc with sfdx-hardis
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+      - run: yarn
+      - run: yarn prepack
+      - run: npm i sfdx-cli -g
+      - run: echo y|sfdx plugins:install sfdx-hardis
+      - run: sfdx hardis:doc:plugin:generate
+      # Deploy docs with mkdocs-material
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material mdx_truly_sane_lists json-schema-for-humans
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -10,3 +10,5 @@ dump.rdb
 mshanemc-*
 commandInventory.json
 heroku-xo*
+
+hardis-report/

README.md

@@ -22,7 +22,7 @@ Way, way down [at the bottom](#How-to-Contribute).
 
 check out [this repo](https://github.com/mshanemc/awesome-sfdx-plugins) for other people's plugins (and share via PR if you've created one)
 
-# Usage
+## Usage
 
 <!-- usage -->
 
@@ -40,7 +40,7 @@ USAGE
 
 <!-- usagestop -->
 
-# Commands
+## Commands
 
 <!-- commands -->
 

docs/data/sosl/query.md

@@ -0,0 +1,31 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# data:sosl:query
+
+## Description
+
+Runs a sosl query.  SOSL Reference: https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl_syntax.htm
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|apiversion|option|override the api version used for api requests made by this command||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|query<br/>-q|option|SOSL query||||
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+
+## Examples
+
+```shell
+sfdx force:data:sosl:query -q "find {something}"
+
+```
+
+```shell
+sfdx force:data:sosl:query -q "find {Jack} returning User(Name), Account(Name),Contact(FirstName,LastName,Department)" -u platformers
+// search across several objects with different results fields on a specified org
+
+```
+
+

docs/javascripts/gtag.js

@@ -0,0 +1,27 @@
+/*
+location$.subscribe(function(url) {
+    window.dataLayer = window.dataLayer || [];
+    function gtag() {
+        dataLayer.push(arguments);
+    }
+    gtag("js", new Date());
+
+    gtag("config", "G-3DM50255LC");
+});
+*/
+var gtag_id = "G-XXXXXXXXXX";
+
+var script = document.createElement("script");
+script.src = "https://www.googletagmanager.com/gtag/js?id=" + gtag_id;
+document.head.appendChild(script);
+
+location$.subscribe(function (url) {
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+
+  gtag("js", new Date());
+  gtag("config", gtag_id);
+});

docs/javascripts/tables.js

@@ -0,0 +1,6 @@
+document$.subscribe(function () {
+    var tables = document.querySelectorAll("article table")
+    tables.forEach(function (table) {
+        new Tablesort(table)
+    })
+})

docs/overrides/main.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<!-- <script async src="https://www.googletagmanager.com/gtag/js?id=G-3DM50255LC"></script> MOVED TO gtag.js -->

docs/shane/ai/auth.md

@@ -0,0 +1,27 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:auth
+
+## Description
+
+get an access token from an email and a .pem file, either passed in or from environment variables
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|certfile<br/>-f|option|path to your private key from when you signed up||||
+|email<br/>-e|option|email address you used when you signed up for your einstein.ai account||||
+|json|boolean|format output as json||||
+|level<br/>-l|option|where to store this config|local||local<br/>global|
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|tokentime<br/>-t|option|time in minutes that you want your token to be valid for|1440|||
+
+## Examples
+
+```shell
+sfdx shane:ai:auth -e [email protected] -f ~/code/certs/einstein_platform.pem
+    // reauths, and takes what it can get
+
+```
+
+

docs/shane/ai/dataset/delete.md

@@ -0,0 +1,23 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:dataset:delete
+
+## Description
+
+delete a dataset
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|dataset<br/>-n|option|dataset id||||
+|email<br/>-e|option|email address you used when you signed up for your einstein.ai account||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+
+## Examples
+
+```shell
+sfdx shane:ai:dataset:delete -n 57
+```
+
+

docs/shane/ai/dataset/get.md

@@ -0,0 +1,25 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:dataset:get
+
+## Description
+
+get an access token from an email and a .pem file, either passed in or from environment variables
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|dataset<br/>-n|option|dataset id||||
+|email<br/>-e|option|email address you used when you signed up for your einstein.ai account||||
+|json|boolean|format output as json||||
+|language<br/>-l|boolean|use the language endpoint instead of vision||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|poll<br/>-p|boolean|poll for the status to be completed||||
+
+## Examples
+
+```shell
+sfdx shane:ai:dataset:get -n 57
+```
+
+

docs/shane/ai/dataset/upload.md

@@ -0,0 +1,29 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:dataset:upload
+
+## Description
+
+upload a dataset
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|email<br/>-e|option|email address you used when you signed up for your einstein.ai account||||
+|file<br/>-f|option|Path to the .zip (image) or .csv/.tsv/.json (language) file on the local drive (FilePart). The maximum file size you can upload from a local drive is 50 MB for images, 25 MB for text||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|name<br/>-n|option|Name of the dataset. Optional. If this parameter is omitted, the dataset name is derived from the .zip file name. ||||
+|path<br/>-p|option|URL of the .zip (image) or .csv/.tsv/.json (language) file. The maximum file size you can upload from a web location is 2 GB (images), 25MB (text) ||||
+|train|boolean|train a model on the dataset||||
+|type<br/>-t|option|Type of dataset data. Valid values are:|image||image<br/>image-detection<br/>image-multi-label<br/>text-intent<br/>text-sentiment|
+|verbose|boolean|emit additional command output to stdout||||
+|wait<br/>-w|option|how long to wait for this to process (minutes)|10|||
+
+## Examples
+
+```shell
+sfdx shane:ai:dataset:upload -e [email protected] -f ~/myPics.zip -n AwesomeDataset 
+```
+
+

docs/shane/ai/playground/setup.md

@@ -0,0 +1,26 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:playground:setup
+
+## Description
+
+upload .pem file from local encrypted copy, setup username and secret key in custom setting
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|apiversion|option|override the api version used for api requests made by this command||||
+|email<br/>-e|option|email address you used when you signed up for your einstein.ai account.  Defaults to EINSTEIN_EMAIL from the environment||||
+|file<br/>-f|option|encrypted file from local filesystem||||
+|json|boolean|format output as json||||
+|key<br/>-k|option|encoding key used to encrypt/decrypt the file.  Defaults to AI_PLAYGROUND_SETUP_KEY from the environment||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+
+## Examples
+
+```shell
+sfdx shane:ai:playground:setup -f my.pem -e [email protected] -k yay9HVn68GzXrqhT0HWkoQ==
+```
+
+

docs/shane/ai/playground/setupHeroku.md

@@ -0,0 +1,41 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:ai:playground:setupHeroku
+
+## Description
+
+provisions a new einstein.ai account and sets up the org
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|apiversion|option|override the api version used for api requests made by this command||||
+|app<br/>-a|option|name of the heroku app that we attach add-ons to||||
+|create<br/>-c|boolean|create the app||||
+|json|boolean|format output as json||||
+|keepauth<br/>-k|boolean|save the refresh token for einstein.ai to the local sfdx store for future cli use||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+|verbose|boolean|emit additional command output to stdout||||
+
+## Examples
+
+```shell
+sfdx shane:ai:playground:herokuSetup -a my-existing-app
+    // creates addons to existing app
+
+```
+
+```shell
+sfdx shane:ai:playground:herokuSetup -c
+    // creates an app with whatever name heroku feels like
+
+```
+
+```shell
+sfdx shane:ai:playground:herokuSetup -a non-existing-app -c
+    // creates a new app with the name of your choice (usually build dynamically!)
+
+```
+
+

docs/shane/analytics/app/share.md

@@ -0,0 +1,31 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:analytics:app:share
+
+## Description
+
+share an analytics app by name
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|allcsp|boolean|share with all customer portal users||||
+|allprm|boolean|share with all partner users||||
+|apiversion|option|override the api version used for api requests made by this command||||
+|community<br/>-c|boolean|enable community sharing||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|name<br/>-n|option|name of the analytics app||||
+|org|boolean|share with all internal users||||
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+|type<br/>-t|option|access level|View||View<br/>Edit<br/>Manage|
+
+## Examples
+
+```shell
+sfdx shane:analytics:app:share -n SharedApp --allprm -c
+// share the standard SharedApp with all partners view level perms (default) and check the "enable sharing with communities" box for this app
+
+```
+
+

docs/shane/analytics/community/enable.md

@@ -0,0 +1,20 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:analytics:community:enable
+
+## Description
+
+Activate a community using a headless browser
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|apiversion|option|override the api version used for api requests made by this command||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|showbrowser<br/>-b|boolean|show the browser...useful for local debugging||||
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+
+## Examples
+
+

docs/shane/analytics/dataflow/start.md

@@ -0,0 +1,27 @@
+<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
+# shane:analytics:dataflow:start
+
+## Description
+
+start an analytics dataflow by name/label/id
+
+## Parameters
+
+|Name|Type|Description|Default|Required|Options|
+|:---|:--:|:----------|:-----:|:------:|:-----:|
+|apiversion|option|override the api version used for api requests made by this command||||
+|id<br/>-i|option|the id of the dataflow||||
+|json|boolean|format output as json||||
+|loglevel|option|logging level for this command invocation|warn||trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal|
+|name<br/>-n|option|name or label of the analytics app (will match either)||||
+|targetusername<br/>-u|option|username or alias for the target org; overrides default target org||||
+
+## Examples
+
+```shell
+sfdx shane:analytics:dataflow:start -n MyDataFlowName
+// enqueue a job for the the analytics dataflow with name/label MyDataFlowName (will not wait for completion of the dataflow)
+
+```
+
+