Skip to content

Document property columns in Resource Explorer#18630

Open
AnuiDolphin wants to merge 5 commits intomasterfrom
emdash/resource-properties-144
Open

Document property columns in Resource Explorer#18630
AnuiDolphin wants to merge 5 commits intomasterfrom
emdash/resource-properties-144

Conversation

@AnuiDolphin
Copy link
Copy Markdown
Contributor

@AnuiDolphin AnuiDolphin commented Apr 20, 2026

Summary

  • Adds a Property columns section to content/docs/insights/discovery/search.md documenting the new dynamic property columns feature in Insights Resource Explorer (pulumi/pulumi-service#40053).
  • Adds a matching bullet to the Key capabilities list in content/docs/insights/discovery/_index.md.

The new section covers:

  • Creating a property column from the settings menu → Create property column dialog, using the same property-path syntax as property queries.
  • Adding a column from the expanded resource detail view via the Create property column action on each input/output property row.
  • Sort, filter, and group-by behavior (identical to built-in columns, including the Row Groups Header).
  • Column-chooser visibility via Choose columns (hide / re-show).
  • Deletion by dragging the column header out of the grid.
  • URL persistence for shared views.
  • Tier gating (Team, Enterprise, Business Critical) via the same info callout already used for property queries.

No screenshots are added -- the written descriptions are detailed enough to stand on their own and avoid the drift risk that comes with UI screenshots.

Test plan

  • `make serve` and visit `/docs/insights/discovery/search/#property-columns` to confirm the new section renders.
  • Confirm the anchor link from the new section back to `#property-queries` works.
  • Confirm the bullet on `/docs/insights/discovery/` reads cleanly in the key capabilities list.
  • Verify wording against the final UI once pulumi/pulumi-service#40053 ships (labels: "Create property column", "Choose columns", "Row Groups Header" -- update if any rename before release).

🤖 Generated with Claude Code

Add a Property columns section to the Resource Search docs covering
creation from the gear menu, adding from the detail view, sort/filter/group
behavior, column chooser visibility, and URL-based view sharing. Reuse the
Team/Enterprise/Business Critical tier callout already used for property
queries, and add a matching bullet to the Discovery key capabilities list.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 20, 2026

Docs review

Solid, well-structured addition. The new section mirrors the existing Property queries pattern (tier-gating callout, property-path link), uses sentence-case headings, and sticks to 1. for ordered lists. Links I checked resolve: /docs/reference/property-paths/ exists, and the #property-queries anchor points at the H3 on line 274 of search.md. No screenshots is the right call given the pre-release timing.

A few small things worth considering:

1. Oxford-comma inconsistency between the two files

content/docs/insights/discovery/_index.md:46 uses with Oxford comma:

…column (Team, Enterprise, and Business Critical editions)

content/docs/insights/discovery/search.md:402 uses without:

…organizations using Team, Enterprise and Business Critical editions.

The search.md wording intentionally matches the existing Property queries callout at line 277 (which also omits the Oxford comma), so this PR is internally consistent with its neighbor — but the two new additions disagree with each other. Google's Developer Documentation Style Guide prefers the serial comma. Low-stakes suggestion: align both on the Oxford-comma form. For search.md:402:

Property columns are only available to organizations using Team, Enterprise, and Business Critical editions.

(You may also want to update the existing Property queries callout on line 277 to match, though that's arguably out of scope for this PR.)

2. Long bullet in _index.md

_index.md:46 is noticeably longer than the surrounding bullets in the Key capabilities list — it packs two examples and a tier-gating parenthetical into a single line. Consider tightening, e.g.:

- **Property columns**: Promote any resource property (such as `tags.Environment` or `instanceType`) into a sortable, filterable, and groupable column (Team, Enterprise, and Business Critical editions)

Or drop the inline examples entirely and let the full search.md section carry them. Not blocking — just matches the brevity of the surrounding bullets better.

3. first-class column phrasing

search.md:407 uses first-class column, which is idiomatic to engineers but borderline jargon for a user-facing docs page. A small rephrase would work, e.g. behaves like any built-in column in the results grid. Optional.

4. UI label capitalization — confirm against final UI

The section references specific UI strings that the author also flagged in the PR test plan: Create property column, Add as column, and Row Groups Header (search.md:415, 423, 433). Worth a double-check against pulumi/pulumi-service#40053 once that ships, especially Row Groups Header — that's an unusual capitalization and easy for the UI to drift on.

5. Sharing-views wording

search.md:441Property column configuration is persisted in the page URL reads a little passive. Minor polish option:

The set of property columns is persisted in the page URL. Share the URL with another member of your organization and they will open the grid with the same property columns, filters, sort order, and grouping applied.

Take it or leave it.


Nothing here is blocking — overall this is a clean, tightly scoped PR. Mention @claude if you'd like another pass after changes.

Comment thread content/docs/insights/discovery/search.md Outdated
@pulumi-bot
Copy link
Copy Markdown
Collaborator

pulumi-bot commented Apr 20, 2026

Comment thread content/docs/insights/discovery/search.md Outdated
Comment thread content/docs/insights/discovery/search.md Outdated
- Use "settings icon" instead of "gear icon" for the menu control
- Rewrite the detail-view section: drill in via the name cell, and
  document the single Create property column action whose behavior
  depends on whether the value is a singleton or an object with children
- Replace "hiding and showing" with "hiding and deleting": hiding is
  done via Choose columns in the settings menu; deletion is done by
  dragging a property column out of the grid, and only works for
  property columns (not built-in columns)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add Oxford comma to the Property columns tier callout in search.md
  for consistency with the bullet in _index.md
- Drop 'first-class column' phrasing; the next sentence already
  explains the behavior
- Rewrite the sharing-views paragraph in active voice
- Tighten the Key capabilities bullet to match the brevity of its
  neighbors by dropping the inline examples (still covered in full
  in search.md)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@AnuiDolphin
Copy link
Copy Markdown
Contributor Author

Thanks for the detailed pass, @claude. Addressed in fbdc82f:

  1. Oxford comma — added to the Property columns callout in search.md for consistency with the _index.md bullet. Left the existing Property queries callout alone as out of scope.
  2. Long bullet in _index.md — dropped the inline examples; the full search.md section carries them.
  3. first-class column phrasing — dropped; the next sentence already explains the behavior.
  4. UI label capitalization — re-checked. Row Groups Header matches how it's already capitalized earlier in this same file (existing Resource search grouping section). Other labels will be re-verified against the shipped UI.
  5. Sharing-views wording — rewrote in active voice.

@pulumi-bot
Copy link
Copy Markdown
Collaborator

pulumi-bot commented Apr 20, 2026

Claude finished @AnuiDolphin's task in 41s —— View job


Second-pass review

  • Read the updated files to verify the five addressed items
  • Confirm no new issues introduced
  • Post findings

All five items from the first review are confirmed addressed in the current branch:

  1. Oxford comma (search.md:402) — "Team, Enterprise, and Business Critical editions" ✅. The pre-existing property queries callout at line 277 still omits it, which is consistent with the author's stated out-of-scope decision.

  2. Long bullet in _index.md:46 — inline examples dropped; now reads cleanly as "Promote any resource property into a sortable, filterable, and groupable column (Team, Enterprise, and Business Critical editions)"

  3. first-class column phrasing (search.md:407) — replaced with "behaves like any built-in column"

  4. UI label capitalizationRow Groups Header at line 437 matches existing usage elsewhere in the file ✅. Other labels (Create property column, Add as column, Choose columns) read naturally; re-verification against shipped UI is noted in the test plan.

  5. Sharing-views wording (search.md:445–448) — active voice, well-scoped sentence about sharing with org members ✅

The additional author-driven corrections (gear → settings icon, detail-view entry via name cell, single Create property column action with singleton-vs-object branching, Hiding and deleting property columns split into two distinct behaviors) all look correct and accurate based on the description provided.

This is clean and ready to merge.

Replace three em-dashes in the new property-columns content with
periods / a semicolon so the voice matches the rest of search.md,
which has no em-dashes elsewhere.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, Craig. One small voice tweak pushed: smoothed three em-dashes in the property-columns section since they were the only ones in the file. Also refreshed the PR body so the UI labels match the final wording ("Create property column" / "Choose columns" / settings menu).

Worth one last pass against the preview once pulumi/pulumi-service#40053 ships, particularly the deletion flow (drag column out of grid) and the URL-persistence claim. Otherwise ready to merge whenever.

http://www-testing-pulumi-docs-origin-pr-18630-fbdc82f5.s3-website.us-west-2.amazonaws.com/docs/insights/discovery/search/#property-columns

Comment thread content/docs/insights/discovery/search.md Outdated
Comment thread content/docs/insights/discovery/search.md Outdated
Co-authored-by: Craig Symonds <craig@anui.com>
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.

3 participants