[HTTP] Added documentationLink guidance (#204774)

## Summary Gives developers a better chance of discovering the process of creating a release note.
elastic · Dec 19, 2024 · e4b4101 · e4b4101
1 parent e8e4e75
commit e4b4101
Showing 1 changed file with 3 additions and 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
@@ -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 `<REPO_ROOT>/docs/upgrade-notes.asciidoc` for instructions on adding a release note.
    */
   documentationUrl: string;
   /**