[DBMON-6861] Fix stale azure field name and spec link in SQL Server setup docs - #38494
[DBMON-6861] Fix stale azure field name and spec link in SQL Server setup docs#38494pierreln-dd wants to merge 6 commits into
Conversation
…etup docs Replace leftover `name` field references with `fully_qualified_domain_name` in code samples and prose across all Azure SQL Server setup tabs, and update the integration spec permalink to the current line range.
Preview links (active after the
|
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
There was a problem hiding this comment.
More details
The renamed Azure field is consistent across all seven YAML examples and the Docker JSON example, and the updated spec permalink resolves to the integration spec's Azure block containing fully_qualified_domain_name. No diff-introduced behavioral regression was found.
📊 Validated against 8 scenarios · Open Bits AI session
🤖 Datadog Autotest · Commit 6fae6e8 · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
Looks great! My only feedback is the same thing, four times - the line highlighting appeared to end a little early, so I just suggested extending all of these to line 841. I've approved your PR, though, so feel free to merge whenever you like after that's fixed!
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
| [1]: https://app.datadoghq.com/account/settings/agent/latest?platform=windows | ||
| [2]: https://github.com/DataDog/integrations-core/blob/master/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example | ||
| [3]: https://github.com/DataDog/integrations-core/blob/master/sqlserver/assets/configuration/spec.yaml#L353-L383 | ||
| [3]: https://github.com/DataDog/integrations-core/blob/master/sqlserver/assets/configuration/spec.yaml#L797-L841 |
There was a problem hiding this comment.
Hm how do we usually handle linking to lines of code in documentation? This is brittle because the lines will be wrong the second something changes above these line ranges. It's usually better to use permalinks to the exact commit sha, but that also is susceptible to staleness, but it does retain the expected material from right now
There was a problem hiding this comment.
Yeah I was thinking about that too, I just updated them for now, but may be worth removing entirely
3 participants
What does this PR do? What is the motivation?
Fixes DBMON-6861
The Azure SQL Server setup page mixed up the
azureblock's field name: several code samples and prose sentences referenced anamefield that doesn't exist in the integration spec, while the actual field isfully_qualified_domain_name. The field was renamed fromnametofully_qualified_domain_namein integrations-core#14534; these docs were never updated to match. This page also linked to a specific line range in the integration spec on GitHub that no longer matches the current file.This PR:
"name"key with"fully_qualified_domain_name"in the Docker configuration JSON sampledeployment_typeandnamefields" sentences to referencefully_qualified_domain_nameazureconfig blockMerge instructions
Merge readiness:
Additional notes