Skip to content

Commit

Permalink
Documents helper script
Browse files Browse the repository at this point in the history
  • Loading branch information
lukestanley committed Oct 25, 2023
1 parent bf3e369 commit ae601c4
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,29 @@ Run the following commands (from the root of the repository, or change the paths
sphinx-autobuild docs/ docs/_build/html

Then go to http://127.0.0.1:8000 in the browser.

Investigating Block usage in saved Flows
-----------------------------------------
To help improve the documentation, developers can research block usage in existing
Flows that are saved to Flow Cloud, by configuring and using a Node.js script in the
source repository.
This script is designed to explore the configuration used for particular blocks in
flows saved to Flow Cloud. It can filter by a specific config property, allowing for
more targeted analysis. Modify the script to specify what property is of interest.

The script helps identify patterns or common configurations for specific block types, and
assists in auditing and understanding how a particular property is being used across
multiple flows. The results are output to JSON files on disk for further analysis.

The script is located at `docs/extract-example-block-usage-from-flows.js` in the git
repository.

Usage:

.. prompt:: bash $

cd docs
node extract-example-block-usage-from-flows.js

This will run the script and output the results to a JSON file located at
'flow-analysis/flow-block-config-analysis.json'.

0 comments on commit ae601c4

Please sign in to comment.