open-vault/ui/lib/core/addon/components/doc-link.js
claire bontempo 45737ddd3c
UI: Fix remaining DocLink paths (#20070)
* fix remaining doclinks

* add changelog

* Apply suggestions from code review

fix links
2023-04-10 23:26:50 +00:00

27 lines
675 B
JavaScript

/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import ExternalLink from './external-link';
/**
* @module DocLink
* `DocLink` components are used to render anchor links to relevant Vault documentation at developer.hashicorp.com.
*
* @example
* ```js
<DocLink @path="/vault/docs/secrets/kv/kv-v2.html">Learn about KV v2</DocLink>
* ```
*
* @param {string} path="/" - The path to documentation on developer.hashicorp.com that the component should link to.
*
*/
export default class DocLinkComponent extends ExternalLink {
host = 'https://developer.hashicorp.com';
get href() {
return `${this.host}${this.args.path}`;
}
}