Revamp site

turbot · Feb 15, 2025 · 43aadd6 · 43aadd6
1 parent 4856be6
commit 43aadd6
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 56 deletions.
diff --git a/.github/workflows/trigger-flowpipe-io.yml b/.github/workflows/trigger-flowpipe-io.yml
@@ -7,6 +7,9 @@ on:
     branches-ignore: 
       - "main"
 
+  pull_request:
+    types: [opened]
+
 jobs:
   update:
     runs-on: ubuntu-latest
@@ -16,6 +19,50 @@ jobs:
         uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.G_PERSONAL_ACCESS_TOKEN }}
-          repository: turbotio/flowpipe.io
-          event-type: build-preview
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}", "ref_name": "${{ github.ref_name }}"}'
+          repository: turbot/flowpipe.io
+          event-type: build-preview-test
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}", "ref_name": "${{ github.ref_name }}"}'
+
+
+  comment-link:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    if: ${{ github.event_name == 'pull_request' && github.event.action == 'opened' }}
+    steps:
+      - name: Get the deployment details
+        id: get_deployment_details
+        if: ${{ github.event_name == 'pull_request' && github.event.action == 'opened' }}
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const branchName = 'docs/${{ github.event.pull_request.head.ref }}';
+
+            const response = await fetch('https://flowpipe-io.vercel.app/api/service/deploy-details', {
+              method: 'POST',
+              headers: {
+                'Content-Type': 'application/json',
+                'Authorization': 'Bearer ${{ secrets.FLOWPIPE_API_KEY }}',
+              },
+              body: JSON.stringify({ branch: branchName }),
+            });
+            if (!response.ok) {
+              core.setOutput('foundDeployment', false);
+            } else {
+              const data = await response.json();
+              core.setOutput('foundDeployment', true);
+              core.setOutput('apiResponse', data);
+            }
+
+      - name: Add comment with preview link
+        uses: actions/github-script@v7
+        if: ${{ steps.get_deployment_details.outputs.foundDeployment == 'true' }}
+        with:
+          script: |
+            const apiResponse = ${{ steps.get_deployment_details.outputs.apiResponse }};
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `### Preview Available 🚀\n\n**Commit Author:** ${apiResponse.meta.githubCommitAuthorName}\n**Commit Message:** ${apiResponse.meta.githubCommitMessage}\n\n**Preview Link:** [${apiResponse.meta.branchAlias}](https://${apiResponse.meta.branchAlias})`
+            });
diff --git a/.gitignore b/.gitignore
@@ -52,4 +52,8 @@ yarn-error.log*
 /tmp
 content/docs
 
-.vscode
+.vscode
+images/**/*.todo
+images/**/*.keep
+images/**/*.sav
+images/**/*.json
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ We support up to 2 levels of docs, e.g.:
 
 For your docs to appear in the sidebar, you need to edit `docs/sidebar.json`. This is an array of sidebar entries, which are either stings matching the path of the required document, or a category to nest the docs down 1 level.
 
-Any images required by docs must be placed in `/images/docs/...` and must be referenced by the tag `<img src="/images/docs/..." />`.
+Any images required by docs must be placed in `/images/docs/...` and must be referenced by the tag `<img src="/..." />`.
 
 # Guidelines for contribution
 

diff --git a/docs/build/input.md b/docs/build/input.md
@@ -58,12 +58,12 @@ After the user selects a game, the pipeline will send back a message with a hype
 
 If you run the pipeline in [client-mode](/docs/run#operating-modes), pipes will prompt you on the console and wait for your response. 
 
-![](/images/docs/build/input_console_select_game.png)
+![](/build/input_console_select_game.png)
 
 
 Once you respond, the pipeline will continue.
 
-![](/images/docs/build/play_game_console.png)
+![](/build/play_game_console.png)
 
 
 ## Running in Server-Mode
@@ -94,7 +94,7 @@ $ flowpipe pipeline run play_a_game  --host local
 
 Open the URL in your browser.  The form appears.  
 
-![](/images/docs/build/input_http_select_game.png)
+![](/build/input_http_select_game.png)
 
 
 Select a game and then click the **Submit** button. Return to the terminal where you are running the pipeline.  You will see that the pipeline is now finished and the message appears in the output:
@@ -142,4 +142,4 @@ notifier "default" {
 The pipeline that we created earlier already routes the input request to the default notifier.  By adding integrations to the default notifier we can route the input request to Slack and/or email without modifying the pipeline!
 
 
-![](/images/docs/build/input_slack_select_game.png)
+![](/build/input_slack_select_game.png)
diff --git a/docs/flowpipe-hcl/step/input.md b/docs/flowpipe-hcl/step/input.md
@@ -91,14 +91,14 @@ This step also supports the [common step arguments](/docs/flowpipe-hcl/step#comm
 ### Button - Simple 
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_button_simple_console.png)
+![](/flowpipe-hcl/input_button_simple_console.png)
 
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_button_simple_http.png)
+![](/flowpipe-hcl/input_button_simple_http.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_button_simple_slack.png)
+![](/flowpipe-hcl/input_button_simple_slack.png)
 
 
 ```hcl
@@ -126,13 +126,13 @@ pipeline "my_pipe" {
 ### Button - With labels and values 
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_button_simple_console.png)
+![](/flowpipe-hcl/input_button_simple_console.png)
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_button_simple_http.png)
+![](/flowpipe-hcl/input_button_simple_http.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_button_simple_slack.png)
+![](/flowpipe-hcl/input_button_simple_slack.png)
 
 
 ```hcl
@@ -167,14 +167,14 @@ pipeline "my_pipe" {
 ### Select - basic
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_select_simple_console.png)
+![](/flowpipe-hcl/input_select_simple_console.png)
 
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_select_simple_http_open.png)
+![](/flowpipe-hcl/input_select_simple_http_open.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_select_simple_slack_open.png)
+![](/flowpipe-hcl/input_select_simple_slack_open.png)
 
 
 ```hcl
@@ -208,13 +208,13 @@ pipeline "my_select" {
 #### Select - with labels & default selection
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_select_labels_console.png)
+![](/flowpipe-hcl/input_select_labels_console.png)
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_select_labels_http_open.png)
+![](/flowpipe-hcl/input_select_labels_http_open.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_select_labels_slack_open.png)
+![](/flowpipe-hcl/input_select_labels_slack_open.png)
 
 
 ```hcl
@@ -257,14 +257,14 @@ pipeline "my_select_labels" {
 ### Multiselect  - basic
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_multiselect_simple_console.png)
+![](/flowpipe-hcl/input_multiselect_simple_console.png)
 
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_multiselect_simple_http_selected.png)
+![](/flowpipe-hcl/input_multiselect_simple_http_selected.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_multiselect_simple_slack_selected.png)
+![](/flowpipe-hcl/input_multiselect_simple_slack_selected.png)
 
 
 ```hcl
@@ -299,14 +299,14 @@ pipeline "my_multi" {
 ### Multiselect with labels & default selection
 
 ##### Console (Client-Mode)
-![](/images/docs/flowpipe-hcl/input_multiselect_labels_console_selected.png)
+![](/flowpipe-hcl/input_multiselect_labels_console_selected.png)
 
 
 ##### HTTP
-![](/images/docs/flowpipe-hcl/input_multiselect_labels_http_selected.png)
+![](/flowpipe-hcl/input_multiselect_labels_http_selected.png)
 
 ##### Slack
-![](/images/docs/flowpipe-hcl/input_multiselect_labels_slack_selected.png)
+![](/flowpipe-hcl/input_multiselect_labels_slack_selected.png)
 
 
 ```hcl

diff --git a/docs/flowpipe-hcl/trigger/http.md b/docs/flowpipe-hcl/trigger/http.md
@@ -87,7 +87,7 @@ trigger "http" "my_webhook" {
 
 Flowpipe creates an endpoint on the flowpipe server for each `http` trigger. The HTTP webhook does not support any authentication mechanism, but it does have a URL with randomness to make it unguessable.  The webhook URL path is: `/api/latest/hook/{trigger HCL label}/{random string}`, eg `/api/latest/hook/my_webhook/21ifp8truzi8y2r29jdl0qi7qt`
 
-The webhook URL will remain consistent across restarts. The {random string} is generated using the trigger name (the block label of the `trigger` ) and a global salt value.  
+The webhook URL will remain consistent across restarts. The &lcub;random string&rcub; is generated using the trigger name (the block label of the `trigger` ) and a global salt value.  
   - Because the URL contains the trigger name, changing the trigger name will generate a new URL.  
   - The salt value is stored in `~/.flowpipe/internal/salt`
   - If the file is missing or empty, flowpipe will randomly generate a new salt and write it there.  If you want to change *all* of your webhook URLs, remove the salt value.

diff --git a/docs/learn.md b/docs/learn.md
@@ -55,7 +55,7 @@ Let's run it!
 flowpipe pipeline run learn_flowpipe
 ```
 
-![](/images/docs/learn/get-ipv4.png)
+![](/learn/get-ipv4.png)
 
 Flowpipe runs the pipeline and prints its outputs once it is complete.
 
@@ -65,7 +65,7 @@ When troubleshooting, it's often useful to view more information about the curre
 flowpipe pipeline run learn_flowpipe --verbose
 ```
 
-![](/images/docs/learn/get-ipv4-verbose.png)
+![](/learn/get-ipv4-verbose.png)
 
 ## Using mods
 
@@ -102,7 +102,7 @@ You can run pipelines from the dependency mod on the command line:
 flowpipe pipeline run reallyfreegeoip.pipeline.get_ip_geolocation --arg ip_address=35.236.238.30
 ```
 
-![](/images/docs/learn/reallyfreegeoip.png)
+![](/learn/reallyfreegeoip.png)
 
 ## Composing with pipelines
 
@@ -201,7 +201,7 @@ pipeline "learn_flowpipe" {
 }
 ```
 
-![](/images/docs/learn/weather-report.png)
+![](/learn/weather-report.png)
 
 
 
@@ -239,5 +239,5 @@ flowpipe server &
 flowpipe pipeline run learn_flowpipe --host local
 ```
 
-![](/images/docs/learn/slack-weather-report.png)
+![](/learn/slack-weather-report.png)
 
diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md
@@ -31,80 +31,84 @@ sidebar_label: Flowpipe CLI
 ## Global Flags
 
 <table>
+<thead>
   <tr> 
     <th> Flag </th> 
     <th> Description </th> 
   </tr>
+</thead>
 
+<tbody>
   <tr> 
-    <td nowrap="true"> <inlineCode>--config-path</inlineCode> </td> 
+    <td nowrap="true"> `--config-path` </td> 
     <td>  
-    Sets the search path for <a href = "/docs/reference/config-files">configuration files</a>. This argument accepts a colon-separated list of directories.  All configuration files (<inlineCode>*.fpc</inlineCode>) will be loaded from each path, with decreasing precedence.  The default is <inlineCode>.:$FLOWPIPE_INSTALL_DIR/config</inlineCode> (<inlineCode>.:~/.flowpipe/config</inlineCode>).  This allows you to manage your <a href="/docs/reference/config-files/workspace"> workspaces </a> and <a href="/docs/reference/config-files/connection">connections</a> centrally in the <inlineCode>~/.flowpipe/config</inlineCode> directory, but override them in the working directory / mod location if desired.
+    Sets the search path for <a href = "/docs/reference/config-files">configuration files</a>. This argument accepts a colon-separated list of directories.  All configuration files (`*.fpc`) will be loaded from each path, with decreasing precedence.  The default is `.:$FLOWPIPE_INSTALL_DIR/config` (`.:~/.flowpipe/config`).  This allows you to manage your <a href="/docs/reference/config-files/workspace"> workspaces </a> and <a href="/docs/reference/config-files/connection">connections</a> centrally in the `~/.flowpipe/config` directory, but override them in the working directory / mod location if desired.
     </td> 
   </tr>
 
   <tr> 
-    <td nowrap="true"> <inlineCode>--data-dir</inlineCode> </td> 
+    <td nowrap="true"> `--data-dir` </td> 
     <td>  
     Sets the event store data directory. Flowpipe defaults to the `.flowpipe` directory in the current mod directory. This argument allows you to specify a different directory.
     </td> 
   </tr>
 
 
   <tr> 
-    <td nowrap="true"> <inlineCode>-h</inlineCode>, <inlineCode>--help</inlineCode> </td> 
+    <td nowrap="true"> `-h`, `--help` </td> 
     <td>  Help for Flowpipe. </td> 
   </tr>
                   
   <tr> 
-    <td nowrap="true"> <inlineCode>--host</inlineCode> </td> 
-    <td> Run the command against a local or remote server instance.  You may specify the full host and port (e.g. <inlineCode>--host https://flowpipe.my-org.com:7103</inlineCode>), or use the keyword <inlineCode>local</inlineCode> to connect to the local server instance as a shortcut for <inlineCode>https://localhost:7103</inlineCode> (e.g. <inlineCode>--host local</inlineCode>) </td> 
+    <td nowrap="true"> `--host` </td> 
+    <td> Run the command against a local or remote server instance.  You may specify the full host and port (e.g. `--host https://flowpipe.my-org.com:7103`), or use the keyword `local` to connect to the local server instance as a shortcut for `https://localhost:7103` (e.g. `--host local`) </td> 
   </tr>
 
   <tr> 
-    <td nowrap="true">  <inlineCode>--input</inlineCode> </td>
-    <td> Enable interactive prompts (default <inlineCode>true</inlineCode>). </td>
+    <td nowrap="true">  `--input` </td>
+    <td> Enable interactive prompts (default `true`). </td>
   </tr>
 
 
   <tr> 
-    <td nowrap="true">  <inlineCode>--max-concurrency-container int</inlineCode> </td>
-    <td>Set the maximum number of <inlineCode>container</inlineCode> step instances that can execute concurrently across all pipeline instances (default <inlineCode>25</inlineCode>). </td>
+    <td nowrap="true">  `--max-concurrency-container int` </td>
+    <td>Set the maximum number of `container` step instances that can execute concurrently across all pipeline instances (default `25`). </td>
   </tr>
   <tr> 
-    <td nowrap="true">  <inlineCode>--max-concurrency-function int</inlineCode> </td>
-    <td> Set the maximum number of <inlineCode>function</inlineCode> step instances that can execute concurrently across all pipeline instances (default <inlineCode>50</inlineCode>). </td>
+    <td nowrap="true">  `--max-concurrency-function int` </td>
+    <td> Set the maximum number of `function` step instances that can execute concurrently across all pipeline instances (default `50`). </td>
   </tr>
   <tr> 
-    <td nowrap="true">  <inlineCode>--max-concurrency-http int</inlineCode> </td>
-    <td> Set the maximum number of <inlineCode>http</inlineCode> step instances that can execute concurrently across all pipeline instances (default <inlineCode>500</inlineCode>). </td>
+    <td nowrap="true">  `--max-concurrency-http int` </td>
+    <td> Set the maximum number of `http` step instances that can execute concurrently across all pipeline instances (default `500`). </td>
   </tr>
   <tr> 
-    <td nowrap="true">  <inlineCode>--max-concurrency-query int</inlineCode> </td>
-    <td> Set the maximum number of <inlineCode>query</inlineCode> step instances that can execute concurrently across all pipeline instances (default <inlineCode>50</inlineCode>). </td>
+    <td nowrap="true">  `--max-concurrency-query int` </td>
+    <td> Set the maximum number of `query` step instances that can execute concurrently across all pipeline instances (default `50`). </td>
   </tr>
 
 
 
   <tr> 
-    <td nowrap="true"> <inlineCode>--mod-location</inlineCode>  </td> 
+    <td nowrap="true"> `--mod-location`  </td> 
     <td> Sets the Flowpipe workspace working directory.  If not specified, the workspace directory will be set to the current working directory.  See <a href="/docs/reference/env-vars/flowpipe_mod_location">FLOWPIPE_MOD_LOCATION</a> for details. </td>
   </tr>
 
    <tr> 
-    <td nowrap="true">  <inlineCode>--output</inlineCode> </td> 
-    <td>  Select a console output format: <inlineCode>pretty</inlineCode>, <inlineCode>plain</inlineCode>, <inlineCode>yaml</inlineCode> or <inlineCode>json</inlineCode> (default <inlineCode>pretty</inlineCode>). </td>
+    <td nowrap="true">  `--output` </td> 
+    <td>  Select a console output format: `pretty`, `plain`, `yaml` or `json` (default `pretty`). </td>
   </tr>
 
   <tr> 
-    <td nowrap="true"> <inlineCode>-v</inlineCode>, <inlineCode>--version</inlineCode>  </td> 
+    <td nowrap="true"> `-v`, `--version`  </td> 
     <td>  Display Flowpipe version. </td> 
   </tr>
 
   <tr> 
-    <td nowrap="true"> <inlineCode>--workspace	</inlineCode>  </td> 
+    <td nowrap="true"> `--workspace	`  </td> 
     <td>  Sets the Flowpipe workspace profile. If not specified, the default workspace will be used if it exists. See <a href="/docs/reference/env-vars/flowpipe_workspace">FLOWPIPE_WORKSPACE</a> for details. </td> 
   </tr>
+</tbody>
 
 </table>
 
@@ -113,12 +117,12 @@ sidebar_label: Flowpipe CLI
 <!--
 
   <tr> 
-    <td nowrap="true"> <inlineCode>--pipes-host</inlineCode>  </td> 
+    <td nowrap="true"> `--pipes-host`  </td> 
     <td>  Sets the host used when connecting to Turbot Pipesworkspaces.  See <a href="/docs/reference/env-vars/pipes_host">PIPES_HOST</a> for details. </td>
   </tr>
 
   <tr> 
-    <td nowrap="true"> <inlineCode>--pipes-token</inlineCode>  </td> 
+    <td nowrap="true"> `--pipes-token`  </td> 
     <td>  Sets the authentication token used when connecting to Turbot Pipes workspaces.  See <a href="/docs/reference/env-vars/pipes_token">PIPES_TOKEN</a> for details. </td>
   </tr>