From e4b41011ecdaf89702222e5d43320429f653d42d Mon Sep 17 00:00:00 2001 From: Jean-Louis Leysens Date: Thu, 19 Dec 2024 09:26:10 +0100 Subject: [PATCH] [HTTP] Added `documentationLink` guidance (#204774) ## Summary Gives developers a better chance of discovering the process of creating a release note. --- packages/core/http/core-http-server/src/router/route.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/core/http/core-http-server/src/router/route.ts b/packages/core/http/core-http-server/src/router/route.ts index 5480c38d9cd1c..c8d0683234dc7 100644 --- a/packages/core/http/core-http-server/src/router/route.ts +++ b/packages/core/http/core-http-server/src/router/route.ts @@ -121,7 +121,9 @@ export type Privilege = string; */ export interface RouteDeprecationInfo { /** - * link to the documentation for more details on the deprecation. + * Link to the documentation for more details on the deprecation. + * + * @remark See template and instructions in `/docs/upgrade-notes.asciidoc` for instructions on adding a release note. */ documentationUrl: string; /**