Add title to docs links (#1298)

This commit is contained in:
Lukas 2022-10-21 18:57:58 +02:00 committed by GitHub
parent dcedddb2f2
commit 44a63b928d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 29 additions and 36 deletions

View file

@ -13,6 +13,7 @@
"color_scheme_light": "Switch to dark mode", "color_scheme_light": "Switch to dark mode",
"color_scheme_dark": "Switch to light mode", "color_scheme_dark": "Switch to light mode",
"unknown_error": "An unknown error occurred", "unknown_error": "An unknown error occurred",
"documentation_for": "Documentation for \"{topic}\"",
"not_found": { "not_found": {
"not_found": "Whoa 404, either we broke something or you had a typing mishap :-/", "not_found": "Whoa 404, either we broke something or you had a typing mishap :-/",
"back_home": "Back to home" "back_home": "Back to home"

View file

@ -5,7 +5,7 @@
<h1 class="text-xl text-color">{{ $t('admin.settings.secrets.secrets') }}</h1> <h1 class="text-xl text-color">{{ $t('admin.settings.secrets.secrets') }}</h1>
<p class="text-sm text-color-alt"> <p class="text-sm text-color-alt">
{{ $t('admin.settings.secrets.desc') }} {{ $t('admin.settings.secrets.desc') }}
<DocsLink url="docs/usage/secrets" /> <DocsLink :topic="$t('admin.settings.secrets.secrets')" url="docs/usage/secrets" />
</p> </p>
<Warning :text="$t('admin.settings.secrets.warning')" /> <Warning :text="$t('admin.settings.secrets.warning')" />
</div> </div>

View file

@ -1,5 +1,9 @@
<template> <template>
<a :href="`${docsUrl}`" target="_blank" class="text-blue-500 hover:text-blue-600 cursor-pointer mt-1" <a
:href="`${docsUrl}`"
:title="$t('documentation_for', { topic: topic })"
target="_blank"
class="text-blue-500 hover:text-blue-600 cursor-pointer mt-1"
><Icon name="question" class="!w-4 !h-4" ><Icon name="question" class="!w-4 !h-4"
/></a> /></a>
</template> </template>
@ -9,14 +13,13 @@ import { computed, toRef } from 'vue';
import Icon from '~/components/atomic/Icon.vue'; import Icon from '~/components/atomic/Icon.vue';
const props = defineProps({ const props = defineProps<{
url: { url: string;
type: String, topic: string;
required: true, }>();
},
});
const docsBaseUrl = window.WOODPECKER_DOCS; const docsBaseUrl = window.WOODPECKER_DOCS;
const url = toRef(props, 'url'); const url = toRef(props, 'url');
const topic = toRef(props, 'topic');
const docsUrl = computed(() => (url.value.startsWith('http') ? url.value : `${docsBaseUrl}${url.value}`)); const docsUrl = computed(() => (url.value.startsWith('http') ? url.value : `${docsBaseUrl}${url.value}`));
</script> </script>

View file

@ -1,8 +1,8 @@
<template> <template>
<div class="flex flex-col mt-2 mb-4"> <div class="flex flex-col mt-2 mb-4">
<div class="flex items-center text-color font-bold mb-2"> <div class="flex items-center text-color font-bold mb-2">
<label v-if="label" v-bind="$attrs">{{ label }}</label> <label v-bind="$attrs">{{ label }}</label>
<DocsLink v-if="docsUrl" :url="docsUrl" class="ml-2" /> <DocsLink v-if="docsUrl" :topic="label" :url="docsUrl" class="ml-2" />
</div> </div>
<slot /> <slot />
<div v-if="$slots['description']" class="ml-1 text-color-alt"> <div v-if="$slots['description']" class="ml-1 text-color-alt">
@ -11,28 +11,17 @@
</div> </div>
</template> </template>
<script lang="ts"> <script lang="ts" setup>
import { defineComponent } from 'vue';
import DocsLink from '~/components/atomic/DocsLink.vue'; import DocsLink from '~/components/atomic/DocsLink.vue';
export default defineComponent({ defineProps<{
name: 'InputField', label: string;
docsUrl?: string;
components: { DocsLink }, }>();
</script>
inheritAttrs: false,
<script lang="ts">
props: { export default {
label: { inheritAttrs: false,
type: String, };
default: null,
},
docsUrl: {
type: String,
default: null,
},
},
});
</script> </script>

View file

@ -5,7 +5,7 @@
<h1 class="text-xl text-color">{{ $t('org.settings.secrets.secrets') }}</h1> <h1 class="text-xl text-color">{{ $t('org.settings.secrets.secrets') }}</h1>
<p class="text-sm text-color-alt"> <p class="text-sm text-color-alt">
{{ $t('org.settings.secrets.desc') }} {{ $t('org.settings.secrets.desc') }}
<DocsLink url="docs/usage/secrets" /> <DocsLink :topic="$t('org.settings.secrets.secrets')" url="docs/usage/secrets" />
</p> </p>
</div> </div>
<Button <Button

View file

@ -5,7 +5,7 @@
<h1 class="text-xl text-color">{{ $t('repo.settings.crons.crons') }}</h1> <h1 class="text-xl text-color">{{ $t('repo.settings.crons.crons') }}</h1>
<p class="text-sm text-color-alt"> <p class="text-sm text-color-alt">
{{ $t('repo.settings.crons.desc') }} {{ $t('repo.settings.crons.desc') }}
<DocsLink url="docs/usage/crons" /> <DocsLink :topic="$t('repo.settings.crons.crons')" url="docs/usage/crons" />
</p> </p>
</div> </div>
<Button <Button

View file

@ -5,7 +5,7 @@
<h1 class="text-xl text-color">{{ $t('repo.settings.registries.creds') }}</h1> <h1 class="text-xl text-color">{{ $t('repo.settings.registries.creds') }}</h1>
<p class="text-sm text-color-alt"> <p class="text-sm text-color-alt">
{{ $t('repo.settings.registries.desc') }} {{ $t('repo.settings.registries.desc') }}
<DocsLink url="docs/usage/registries" /> <DocsLink :topic="$t('repo.settings.registries.creds')" url="docs/usage/registries" />
</p> </p>
</div> </div>
<Button <Button

View file

@ -5,7 +5,7 @@
<h1 class="text-xl text-color">{{ $t('repo.settings.secrets.secrets') }}</h1> <h1 class="text-xl text-color">{{ $t('repo.settings.secrets.secrets') }}</h1>
<p class="text-sm text-color-alt"> <p class="text-sm text-color-alt">
{{ $t('repo.settings.secrets.desc') }} {{ $t('repo.settings.secrets.desc') }}
<DocsLink url="docs/usage/secrets" /> <DocsLink :topic="$t('repo.settings.secrets.secrets')" url="docs/usage/secrets" />
</p> </p>
</div> </div>
<Button <Button