luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

UI: Fix remaining DocLink paths (#20070) 

* fix remaining doclinks

* add changelog

* Apply suggestions from code review

fix links
This commit is contained in:
claire bontempo 2023-04-10 17:26:50 -06:00 committed by GitHub
parent 194ce13a95
commit 45737ddd3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelog/20070.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:bug
ui: fixes remaining doc links to include /vault in path
```

6
ui/app/templates/components/keymgmt/distribute.hbs
View File

@ -20,7 +20,7 @@
<AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="key"> <AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="key">
{{this.validMatchError.key}} {{this.validMatchError.key}}
To check compatibility, To check compatibility,
<DocLink class="doc-link-subtle" @path="/docs/secrets/key-management#compatibility">refer to this table</DocLink>. <DocLink class="doc-link-subtle" @path="/vault/docs/secrets/key-management#compatibility">refer to this table</DocLink>.
</AlertInline> </AlertInline>
{{/if}} {{/if}}
</SearchSelect> </SearchSelect>
@ -54,7 +54,7 @@
<AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="new-key"> <AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="new-key">
{{this.validMatchError.key}} {{this.validMatchError.key}}
To check compatibility, To check compatibility,
<DocLink class="doc-link-subtle" @path="/docs/secrets/key-management#compatibility">refer to this table</DocLink>. <DocLink class="doc-link-subtle" @path="/vault/docs/secrets/key-management#compatibility">refer to this table</DocLink>.
</AlertInline> </AlertInline>
{{/if}} {{/if}}
</div> </div>
@ -81,7 +81,7 @@
<AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="provider"> <AlertInline @paddingTop={{true}} @sizeSmall={{true}} @type="danger" data-test-keymgmt-error="provider">
{{this.validMatchError.provider}} {{this.validMatchError.provider}}
To check compatibility, To check compatibility,
<DocLink class="doc-link-subtle" @path="/docs/secrets/key-management#compatibility">refer to this table</DocLink>. <DocLink class="doc-link-subtle" @path="/vault/docs/secrets/key-management#compatibility">refer to this table</DocLink>.
</AlertInline> </AlertInline>
{{/if}} {{/if}}
</SearchSelect> </SearchSelect>

2
ui/app/templates/components/mfa/mfa-login-enforcement-header.hbs
View File

@ -31,7 +31,7 @@
An enforcement will define which auth types, auth mounts, groups, and/or entities will require this MFA method. Keep in An enforcement will define which auth types, auth mounts, groups, and/or entities will require this MFA method. Keep in
mind that only one of these conditions needs to be satisfied. For example, if an authentication method is added here, mind that only one of these conditions needs to be satisfied. For example, if an authentication method is added here,
all entities and groups which make use of that authentication method will be subject to an MFA request. all entities and groups which make use of that authentication method will be subject to an MFA request.
<DocLink @path="/docs/auth/login-mfa">Learn more here.</DocLink> <DocLink @path="/vault/docs/auth/login-mfa">Learn more here.</DocLink>
{{/if}} {{/if}}
</p> </p>
{{#if @isInline}} {{#if @isInline}}

2
ui/app/templates/components/oidc/scope-form.hbs
View File

@ -100,7 +100,7 @@
{{/if}} {{/if}}
<p class="has-top-margin-m"> <p class="has-top-margin-m">
The full list of template parameters can be found The full list of template parameters can be found
<DocLink @path="/docs/concepts/oidc-provider#scopes"> <DocLink @path="/vault/docs/concepts/oidc-provider#scopes">
here. here.
</DocLink> </DocLink>
</p> </p>

2
ui/app/templates/components/pki/config-pki-ca.hbs
View File

@ -252,7 +252,7 @@
<T.Content @defaultClass="tool-tip smaller-font"> <T.Content @defaultClass="tool-tip smaller-font">
<div class="box" data-test-hover-copy-tooltip-text> <div class="box" data-test-hover-copy-tooltip-text>
Deleting a CA is only available via the CLI and API. Deleting a CA is only available via the CLI and API.
<DocLink @path="/api-docs/secret/pki#delete-issuer" class="doc-link-subtle"> <DocLink @path="/vault/api-docs/secret/pki#delete-issuer" class="doc-link-subtle">
Learn more Learn more
</DocLink> </DocLink>
</div> </div>

4
ui/app/templates/components/secret-form-show.hbs
View File

@ -3,7 +3,7 @@
@title="Version {{@modelForData.version}} of this secret has been permanently destroyed" @title="Version {{@modelForData.version}} of this secret has been permanently destroyed"
@message="A version that has been permanently deleted cannot be restored. You can see other versions of this secret in the History menu." @message="A version that has been permanently deleted cannot be restored. You can see other versions of this secret in the History menu."
> >
<DocLink @path="/docs/secrets/kv/kv-v2.html"> <DocLink @path="/vault/docs/secrets/kv/kv-v2">
Learn more Learn more
</DocLink> </DocLink>
</EmptyState> </EmptyState>
@ -13,7 +13,7 @@
@message="A version that has been deleted but can be undeleted using the Version {{@modelForData.version}} menu above. @message="A version that has been deleted but can be undeleted using the Version {{@modelForData.version}} menu above.
You can also see other versions of this secret in the History menu." You can also see other versions of this secret in the History menu."
> >
<DocLink @path="/docs/secrets/kv/kv-v2.html"> <DocLink @path="/vault/docs/secrets/kv/kv-v2">
Learn more Learn more
</DocLink> </DocLink>
</EmptyState> </EmptyState>

2
ui/app/templates/vault.hbs
View File

@ -20,7 +20,7 @@
</span> </span>
{{/if}} {{/if}}
<span> <span>
<DocLink @path="/docs/index.html" class="has-text-grey"> <DocLink @path="/vault" class="has-text-grey">
Documentation Documentation
</DocLink> </DocLink>
</span> </span>

2
ui/app/templates/vault/cluster/access/method/section.hbs
View File

@ -21,7 +21,7 @@
{{#if (not (includes this.model.type (supported-managed-auth-backends)))}} {{#if (not (includes this.model.type (supported-managed-auth-backends)))}}
<div class="has-text-grey has-top-bottom-margin" data-test-doc-link> <div class="has-text-grey has-top-bottom-margin" data-test-doc-link>
The Vault UI only supports configuration for this authentication method. For management, the The Vault UI only supports configuration for this authentication method. For management, the
<DocLink @path="/api/auth">API or CLI</DocLink> <DocLink @path="/vault/api-docs">API or CLI</DocLink>
should be used. should be used.
</div> </div>
{{/if}} {{/if}}

6
ui/app/templates/vault/cluster/access/mfa/methods/create.hbs
View File

@ -28,7 +28,7 @@
<h3 class="is-size-4 has-text-semibold">Settings</h3> <h3 class="is-size-4 has-text-semibold">Settings</h3>
<p class="has-border-top-light has-top-padding-l"> <p class="has-border-top-light has-top-padding-l">
{{this.description}} {{this.description}}
<DocLink @path={{concat "/api-docs/secret/identity/mfa/" this.type}}>Learn more.</DocLink> <DocLink @path={{concat "/vault/api-docs/secret/identity/mfa/" this.type}}>Learn more.</DocLink>
</p> </p>
<Mfa::MethodForm @model={{this.method}} @validations={{this.methodErrors}} class="is-box-shadowless" /> <Mfa::MethodForm @model={{this.method}} @validations={{this.methodErrors}} class="is-box-shadowless" />
<Mfa::MfaLoginEnforcementHeader <Mfa::MfaLoginEnforcementHeader
@ -49,7 +49,7 @@
<p> <p>
Multi-factor authentication (MFA) allows you to set up another layer of security on top of existing authentication Multi-factor authentication (MFA) allows you to set up another layer of security on top of existing authentication
methods. Vault has four available methods. methods. Vault has four available methods.
<DocLink @path="/api-docs/secret/identity/mfa">Learn more.</DocLink> <DocLink @path="/vault/api-docs/secret/identity/mfa">Learn more.</DocLink>
</p> </p>
<div class="is-flex-row has-top-margin-xl"> <div class="is-flex-row has-top-margin-xl">
{{#each this.methodNames as |methodName|}} {{#each this.methodNames as |methodName|}}
@ -77,7 +77,7 @@
{{#if this.type}} {{#if this.type}}
<p class="has-top-margin-l"> <p class="has-top-margin-l">
{{this.description}} {{this.description}}
<DocLink @path={{concat "/api-docs/secret/identity/mfa/" this.type}}>Learn more.</DocLink> <DocLink @path={{concat "/vault/api-docs/secret/identity/mfa/" this.type}}>Learn more.</DocLink>
</p> </p>
{{! in a future release cards may be displayed to choose from either template or custom config for TOTP }} {{! in a future release cards may be displayed to choose from either template or custom config for TOTP }}
{{! if template is selected a user could choose a predefined config for common authenticators and the values would be populated on the model }} {{! if template is selected a user could choose a predefined config for common authenticators and the values would be populated on the model }}

2
ui/app/templates/vault/cluster/access/oidc/assignments/index.hbs
View File

@ -23,7 +23,7 @@
{{#if (eq model.name "allow_all")}} {{#if (eq model.name "allow_all")}}
<div class="is-size-8"> <div class="is-size-8">
This is a built-in assignment that cannot be modified or deleted. This is a built-in assignment that cannot be modified or deleted.
<DocLink @path="/docs/concepts/oidc-provider#assignments"> <DocLink @path="/vault/docs/concepts/oidc-provider#assignments">
Learn more Learn more
</DocLink> </DocLink>
</div> </div>

2
ui/app/templates/vault/cluster/access/oidc/scopes/index.hbs
View File

@ -59,7 +59,7 @@
<EmptyState @title="No scopes yet" data-test-oidc-scope-empty-state> <EmptyState @title="No scopes yet" data-test-oidc-scope-empty-state>
<div> <div>
<p>Use scope to define identity information about the authenticated user. <p>Use scope to define identity information about the authenticated user.
<DocLink @path="/docs/concepts/oidc-provider#scopes"> <DocLink @path="/vault/docs/concepts/oidc-provider#scopes">
Learn more. Learn more.
</DocLink> </DocLink>
</p> </p>

2
ui/app/templates/vault/cluster/secrets/backend/edit-metadata.hbs
View File

@ -15,6 +15,6 @@
<LinkTo @route="vault.cluster.secrets.backend.metadata" @model={{this.model.id}} class="link"> <LinkTo @route="vault.cluster.secrets.backend.metadata" @model={{this.model.id}} class="link">
View Metadata View Metadata
</LinkTo> </LinkTo>
<DocLink @path="/api/secret/kv/kv-v2#create-update-metadata">More here</DocLink> <DocLink @path="/vault/api-docs/secret/kv/kv-v2#create-update-metadata">More here</DocLink>
</EmptyState> </EmptyState>
{{/if}} {{/if}}

2
ui/lib/core/addon/components/doc-link.js
View File

@ -11,7 +11,7 @@ import ExternalLink from './external-link';
* *
* @example * @example
* ```js * ```js
<DocLink @path="/docs/secrets/kv/kv-v2.html">Learn about KV v2</DocLink> <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. * @param {string} path="/" - The path to documentation on developer.hashicorp.com that the component should link to.

2
ui/lib/open-api-explorer/addon/templates/components/swagger-ui.hbs
View File

@ -31,7 +31,7 @@
<code>X-Vault-Namespace: {{R.namespace.path}}</code>. You can also use <code>X-Vault-Namespace: {{R.namespace.path}}</code>. You can also use
<code>{{R.namespace.path}}</code> <code>{{R.namespace.path}}</code>
as an API prefix. See as an API prefix. See
<DocLink @path="/api-docs#namespaces">docs</DocLink> <DocLink @path="/vault/api-docs#namespaces">docs</DocLink>
for examples. for examples.
</NamespaceReminder> </NamespaceReminder>
<div id="{{this.elementId}}-swagger" class="swagger-ember"></div> <div id="{{this.elementId}}-swagger" class="swagger-ember"></div>

2
ui/lib/replication/addon/templates/mode/secondaries/index.hbs
View File

@ -71,7 +71,7 @@
Add secondary Add secondary
</LinkTo> </LinkTo>
{{/if}} {{/if}}
<DocLink @path="/docs/internals/replication.html"> <DocLink @path="/vault/docs/internals/replication">
Learn more Learn more
</DocLink> </DocLink>
</EmptyState> </EmptyState>