Skip to content

[Automated][azure-resource-manager][skip chg] Fix broken ARM linter rule reference links in RPC guidelines coverage #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Automated][azure-resource-manager][skip chg] Fix broken ARM linter rule reference links in RPC guidelines coverage #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions eng/scripts/doc-updater/knowledge/azure-resource-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,17 @@ The library provides an experimental **Agent** base type in `lib/base-types/agen
- How-to guide added: `website/src/content/docs/docs/howtos/ARM/agent-base-type.mdx`.
- The ARM howtos sidebar is auto-generated from the directory (`current-sidebar.ts` → `autogenerate` on `howtos`), so new how-to files need no manual sidebar registration.
- Reference docs (`reference/*.md`) for these lib additions were already regenerated in-commit; no `regen-docs` diff was needed for this batch.

## Rule Renames (use-* rules)

The `core-operations` rule was renamed to `use-interface`. Two rules were added: `use-api-version` and `use-operation-decorator`. When auditing docs, ensure no reference to the old `core-operations` name remains and that every rule slug matches a registered rule name.

## Rule Reference Link Slugs

Rule reference links in the how-to guides point to `docs/libraries/azure-resource-manager/rules/<rule-name>/`, where `<rule-name>` must exactly match the **registered** rule name (including any `arm-`/`arm-resource-` prefix). A common defect is link text using the correct prefixed name while the URL slug drops the prefix (e.g. text `arm-put-operation-response-codes` but URL `rules/put-operation-response-codes)`), producing dead links. `rpc-guidelines-coverage.md` had several of these. Note that some links in these files point to rules owned by other libraries (e.g. `key-visibility-required`, `no-enum`, `non-breaking-versioning`, `operation-missing-api-version`) — those are intentionally un-prefixed.

## Relationship & BillingData (Experimental)

- `Relationship<Properties extends RelationshipProperties>` (`lib/base-types/relationship.tsp`, namespace `Azure.ResourceManager.BaseTypes.Relationships`) is an `ExtensionResource` that applies `@azureBaseType(#{ baseType: BaseType.Relationship, version: ... })` automatically. `RelationshipProperties<ProvisioningState>` carries `baseTypes`, `sourceId`/`sourceTenant`, `targetId`/`targetTenant`, `provisioningState`. New rule: `use-relationship-required-properties`.
- `BillingData` (`lib/common-types/billing-data.tsp`, `@added(Versions.v6)`) is a common-type model for resource billing metadata.
- Both are experimental; do not add new getstarted content for them. Reference docs are auto-generated.
4 changes: 2 additions & 2 deletions eng/scripts/doc-updater/knowledge/azure-resource-manager.meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"lastCommit": "5036a37233b303fd4c59afc2c6c8ffc6d6194e3a",
"lastUpdated": "2026-07-20T10:23:17.492Z",
"lastCommit": "9d5bfaac699cff4defc27914130a65d4bb851390",
"lastUpdated": "2026-08-24T10:12:06.217Z",
"analyzedPaths": [
"packages/typespec-azure-resource-manager/src",
"packages/typespec-azure-resource-manager/lib",
Expand Down
Loading