Update semantic bridge docs for 3.26.2#357
Conversation
Regarding Databricks's new standard usage of the keyword `fields` in metric view yaml.
Use v1.1 and more new supported features for translation Remove deserialization include, and switch to a tabbed interface to allow a user to download and load or copy and deserialize. Shift to a single source of truth for the sample YAML in sample-metricview.yaml, which is transitively included through sample-metricview.md
This file is automatically generated and only creates noise by being checked in.
Include v1.1 properties and translation notes.
- semantic-bridge.md: now a generic feature intro. - semantic-bridge-metric-view-object-model.md: covers the object model only, but not validation or translation notes - semantic-bridge-metric-view-tabular-translation.md: new, specifically covers all translation details
- Include back-reference doc in object model. - Update validation to use a new example for a contextual rule (old duplicate name is now invalid) - Update toc
- General clean up - rename semantic-bridge-fields-and-dimensions to semantic-bridge-metric-view-fields-and-dimensions (file and uid) - add additional references to feature docs - update toc
Still need to update script outputs
Check all docs against source and databricks
Add annotations for WIP code runner, update all output blocks.
There was a problem hiding this comment.
Pull request overview
Updates the Tabular Editor documentation set to reflect the Semantic Bridge changes in the 3.26.2 release, including Metric View v1.1 support, the dimensions→fields terminology shift, and expanded guidance on import/validation/translation.
Changes:
- Refresh Semantic Bridge feature + how-to documentation to v1.1 examples and updated diagnostics/outputs.
- Add new focused docs (translation details, fields vs dimensions clarification, failure handling, import-from-file).
- Clean up navigation and generated artifacts (TOCs, roadmap, remove generated
_site/staticwebapp.config.json), plus update API XML sources and doc filtering.
Reviewed changes
Copilot reviewed 25 out of 34 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| content/references/roadmap.md | Updates roadmap items to reflect current Semantic Bridge enhancements and v1.1 support. |
| content/how-tos/toc.md | Adds new Semantic Bridge how-to entries to the how-to TOC. |
| content/how-tos/semantic-bridge-validate-simple-rules.md | Updates validation examples to Field terminology and v1.1-aware rules. |
| content/how-tos/semantic-bridge-validate-default.md | Refreshes default validation guidance, samples, and outputs for 3.26.2+. |
| content/how-tos/semantic-bridge-validate-contextual-rules.md | Updates contextual rule examples to field/join name collision scenarios and new diagnostics structure. |
| content/how-tos/semantic-bridge-serialize.md | Updates serialization guidance and examples for v1.1 YAML and round-tripping. |
| content/how-tos/semantic-bridge-rename-objects.md | Reworks rename example to a field-focused workflow using the updated object model. |
| content/how-tos/semantic-bridge-remove-object.md | Updates removal examples for fields/measures and aligns with new sample include. |
| content/how-tos/semantic-bridge-metric-view-import-from-file.md | New how-to for importing a Metric View directly from a YAML file. |
| content/how-tos/semantic-bridge-metric-view-handle-failures.md | New troubleshooting how-to for common failure modes and guard patterns. |
| content/how-tos/semantic-bridge-load-inspect.md | Updates inspection examples and outputs to v1.1 and Fields. |
| content/how-tos/semantic-bridge-import.md | Updates import workflow, diagnostics reporting, and adds translation-warning example. |
| content/how-tos/semantic-bridge-how-tos.md | Refreshes Semantic Bridge how-to index and adds troubleshooting section. |
| content/how-tos/semantic-bridge-add-object.md | Updates add-object patterns for field/join/measure and v1.1 constructs. |
| content/how-tos/includes/sample-metricview.yaml | Updates the shared sample YAML to v1.1 features (fields, cardinality, formats, display_name). |
| content/how-tos/includes/sample-metricview.md | Replaces inline YAML with a “download or copy” tabbed include and single-source YAML include. |
| content/how-tos/includes/sample-metricview-deserialize.md | Removes the older deserialize-only include in favor of the new unified sample include. |
| content/features/toc.md | Updates feature TOC entries for the split Semantic Bridge documentation set. |
| content/features/semantic-bridge.md | Updates Semantic Bridge overview, diagnostics snippet, and reorganizes links to new pages. |
| content/features/semantic-bridge-metric-view-validation.md | Updates validation docs to Field terminology and new helper/diagnostic patterns. |
| content/features/semantic-bridge-metric-view-tabular-translation.md | New detailed translation/limitations page for Metric View → Tabular. |
| content/features/semantic-bridge-metric-view-object-model.md | Updates object model docs for v1.1 and new Fields/API surface. |
| content/features/semantic-bridge-metric-view-fields-and-dimensions.md | New clarification page documenting dimensions vs fields and Dimension→Field API migration. |
| content/_apiSource/TOMWrapper.xml | Updates API XML surface (new members, renames, stub types) for generated reference docs. |
| content/_apiSource/TabularEditor3.Shared.xml | Updates shared API XML documentation for new contracts/services/resources. |
| configuration/filterConfig.yml | Excludes generated Databricks SQL parser namespace from published API docs. |
| _site/staticwebapp.config.json | Removes an auto-generated build artifact from source control. |
Files not reviewed (2)
- content/_apiSource/TOMWrapper.xml: Generated file
- content/_apiSource/TabularEditor3.Shared.xml: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-357.westeurope.azurestaticapps.net |
jeroenterheerdt
left a comment
jeroenterheerdt
left a comment
There was a problem hiding this comment.
in general, I'd recommend running this through an AI to make it simpler. These are docs, not prose. It reads like a book sometimes, and I think it can be shorter. AI can be helpful in tightening things up and making it more factual and less "flowerly".
@jeroenterheerdt, could you point out specific sections for this? How-tos are intended to be to-the-point and copy+pastable examples. The feature docs are intended to give a thorough background about the feature and user-facing design. I do not let AI write for me. |
All semantic bridge docs have standardized to talk about "Metric View"
spec or "Metric View" docs, rather than "Databricks", to avoid
confusion when we then link to learn.microsoft.com docs.
All learn.microsoft.com links have had the culture (/en-us/...)
stripped out, so that these don't default to english, just because I
do.
Confirm no 'learn.microsoft.com/en-us/' in semantic bridge:
```shell
# empty result means no culture portion
rg -ni -g 'content/**/semantic-bri*md' 'learn\.microsoft\.com/[a-z]{2,3}-[a-z]{2,4}/'
# empty result means no lines saying databricks doc
rg -ni -g 'content/**/semantic-bri*md' 'databricks.*doc'
# empty result means no lines saying databricks spec; one false positive
rg -ni -g 'content/**/semantic-bri*md' 'databricks.*spec'
```
|
Latest commit addresses all "databricks spec" and "databricks doc" lines, all learn.microsoft links. |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-357.westeurope.azurestaticapps.net |
I didn't say you did, nor did I mean to imply that :) It read very much like a @greggyb doc :). An example of where I think things could be tighter is here: https://delightful-mud-081affe03-357.westeurope.azurestaticapps.net/en/features/semantic-bridge-metric-view-fields-and-dimensions.html#serialization-and-deserialization. It's not the how-to's actually, it's the normal docs. |
Fields-Dimensionsclarification docfieldsin metric view yaml.