From 59ee6ed500009634a6ead0317122d44e55a55de5 Mon Sep 17 00:00:00 2001
From: Michael Kriese <michael.kriese@visualon.de>
Date: Fri, 10 Nov 2023 09:33:13 +0100
Subject: [PATCH] docs: fix links (#25683)
---
tools/docs/manager.ts | 5 +++--
tools/docs/utils.ts | 4 ++--
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/tools/docs/manager.ts b/tools/docs/manager.ts
index df886e7d5b..9ac4a846e7 100644
--- a/tools/docs/manager.ts
+++ b/tools/docs/manager.ts
@@ -10,6 +10,7 @@ import { OpenItems, generateFeatureAndBugMarkdown } from './github-query-items';
import {
formatUrls,
getDisplayName,
+ getModuleLink,
getNameWithUrl,
replaceContent,
} from './utils';
@@ -25,7 +26,7 @@ function getTitle(manager: string, displayName: string): string {
}
function getManagerLink(manager: string): string {
- return `[\`${manager}\`](${manager}/)`;
+ return getModuleLink(manager, `[\`${manager}\``);
}
export const CategoryNames: Record<Category, string> = {
@@ -123,7 +124,7 @@ sidebar_label: ${displayName}
const escapedDatasources = (supportedDatasources || [])
.map(
(datasource) =>
- `[\`${datasource}\`](../../datasource/#${datasource}-datasource)`,
+ `[\`${datasource}\`](../../datasource/${datasource}/index.md)`,
)
.join(', ');
md += `This manager supports extracting the following datasources: ${escapedDatasources}.\n\n`;
diff --git a/tools/docs/utils.ts b/tools/docs/utils.ts
index 38971d020c..ab780472c1 100644
--- a/tools/docs/utils.ts
+++ b/tools/docs/utils.ts
@@ -68,6 +68,6 @@ export async function formatDescription(
return `**Description**:\n\n${content}\n`;
}
-export function getModuleLink(module: string, title: string): string {
- return `[${title ?? module}](${module}/)`;
+export function getModuleLink(module: string, title?: string): string {
+ return `[${title ?? module}](${module}/index.md)`;
}
--
GitLab