Skip to content

docs: clarify scopes for custom SQL dimensions vs SQL Runner#588

Open
joaoviana wants to merge 1 commit intomainfrom
docs/custom-sql-dim-scope-clarification
Open

docs: clarify scopes for custom SQL dimensions vs SQL Runner#588
joaoviana wants to merge 1 commit intomainfrom
docs/custom-sql-dim-scope-clarification

Conversation

@joaoviana
Copy link
Copy Markdown
Contributor

Summary

The custom-roles scope reference had an incorrect description of which scope controls custom SQL dimensions in Explore. This came up while reviewing docs after lightdash#22555, which re-lands the FE hides + diff-aware backend save gate for SQL custom dimension authoring. The PR enforces the `manage:CustomFields` scope, but the docs page didn't mention that scope at all.

  • `references/workspace/custom-roles.mdx`: rename the section from "Manage SQL Runner vs Manage Custom SQL" to "SQL-related scopes". Correct the "Manage Custom Sql" description (it controls saving SQL Runner output as a saved chart, not custom SQL dimensions). Add a third entry for "Manage Custom Fields" — Create and edit custom dimensions — which is the scope that actually gates custom SQL dimension authoring in Explore.
  • `guides/custom-fields.mdx`: extend the "only admin or developer" line to mention that, on Enterprise, the gate can be opened up to any custom role that includes the "Manage Custom Fields" scope. Also clarifies that other users can still use existing custom SQL dimensions in queries.

Test plan

  • Render preview locally / Mintlify preview build passes
  • Verify the new section reads correctly on the custom-roles page (three scope entries, no duplication)
  • Verify the cross-link from `custom-fields.mdx` resolves to the custom-roles page

🤖 Generated with Claude Code

The custom-roles scope reference described "Manage Custom SQL" as the
scope that controls custom SQL dimensions in Explore. That scope
actually controls saving SQL Runner output as a saved chart. Custom SQL
dimension authoring is gated by "Manage Custom Fields" (description:
"Create and edit custom dimensions"), which the page didn't mention at
all.

- references/workspace/custom-roles.mdx: rename the section to
  "SQL-related scopes", correct the "Manage Custom Sql" description,
  add a third entry for "Manage Custom Fields" pointing at custom SQL
  dimensions in Explore.
- guides/custom-fields.mdx: note that on Enterprise, the
  admin/developer requirement can be opened up to any custom role with
  the "Manage Custom Fields" scope.

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

mintlify Bot commented May 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview May 1, 2026, 10:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

🤖 Documentation Bot

All checks passed! No issues found.

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.

1 participant