Skip to content

Conversation

@e-gineer
Copy link

Summary

This PR adds comprehensive documentation for the property block feature within category definitions. Property blocks allow users to customize how individual properties are displayed in the properties pane of node/edge visualizations (graph, flow, and hierarchy).

Changes

Documentation Added to docs/powerpipe-hcl/category.md

  1. Argument Reference Table (line 143)

    • Added property block entry
  2. New "Property Blocks" Section (lines 160-212)

    • Overview of property blocks and their purpose
    • Property Block Arguments table documenting the href argument
    • Complete working example using AWS VPC with property block for vpc_id
    • Explanation of jq template context differences

Key Features Documented

  • Property block syntax: property "property_name" { href = "..." }
  • jq template context: Direct access to properties (e.g., {{.vpc_id}}) without needing .properties. prefix
  • Scope: Works in all node/edge visualizations (graph, flow, hierarchy)
  • Use case: Creating clickable links in the properties pane to related resources

Example

category "aws_vpc" {
  title = "VPC"
  color = "#FF9900"

  property "vpc_id" {
    href = "https://console.aws.amazon.com/vpc?region={{.region}}#VpcDetails:VpcId={{.vpc_id}}"
  }
}

Verification

  • ✅ Follows existing documentation patterns (similar to folding section)
  • ✅ Cross-references to shared concepts (jq templates, node/edge visualizations)
  • ✅ Includes complete working example
  • ✅ Clearly distinguishes from category-level href behavior
  • ✅ Properly scoped to node/edge visualizations only

🤖 Generated with Claude Code

This commit adds comprehensive documentation for the `property` block
feature within category definitions. Property blocks allow customization
of how individual properties are displayed in the properties pane of
node/edge visualizations (graph, flow, and hierarchy).

Key additions:
- Added property block to category Argument Reference table
- Created new "Property Blocks" section with detailed explanation
- Documented property block arguments (href with jq templates)
- Added complete working example with AWS VPC category
- Explained difference between property-level and category-level href
  template contexts

The property block href templates have direct access to all properties
in the node/edge (e.g., {{.vpc_id}}), unlike category-level hrefs which
require the .properties. prefix (e.g., {{.properties.'vpc_id'}}).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link

Preview Available 🚀

Commit Author: Ved misra
Commit Message: Add CHANGELOG for AWS Compliance mod v1.11.0 (#202)

Preview Link: powerpipe-io-git-docs-docsproperty-blocks-turbot.vercel.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants