From 73ea51f461ec41b3dd3846d1477f612b51a9f310 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Sun, 15 Oct 2023 11:32:02 +0100
Subject: [PATCH] docs: rename platform index.md to readme.md (#25215)
---
lib/modules/platform/azure/{index.md => readme.md} | 0
lib/modules/platform/bitbucket-server/{index.md => readme.md} | 0
lib/modules/platform/bitbucket/{index.md => readme.md} | 0
lib/modules/platform/codecommit/{index.md => readme.md} | 0
lib/modules/platform/gitea/{index.md => readme.md} | 0
lib/modules/platform/gitlab/{index.md => readme.md} | 0
lib/modules/platform/local/{index.md => readme.md} | 0
tools/docs/platforms.ts | 2 +-
8 files changed, 1 insertion(+), 1 deletion(-)
rename lib/modules/platform/azure/{index.md => readme.md} (100%)
rename lib/modules/platform/bitbucket-server/{index.md => readme.md} (100%)
rename lib/modules/platform/bitbucket/{index.md => readme.md} (100%)
rename lib/modules/platform/codecommit/{index.md => readme.md} (100%)
rename lib/modules/platform/gitea/{index.md => readme.md} (100%)
rename lib/modules/platform/gitlab/{index.md => readme.md} (100%)
rename lib/modules/platform/local/{index.md => readme.md} (100%)
diff --git a/lib/modules/platform/azure/index.md b/lib/modules/platform/azure/readme.md
similarity index 100%
rename from lib/modules/platform/azure/index.md
rename to lib/modules/platform/azure/readme.md
diff --git a/lib/modules/platform/bitbucket-server/index.md b/lib/modules/platform/bitbucket-server/readme.md
similarity index 100%
rename from lib/modules/platform/bitbucket-server/index.md
rename to lib/modules/platform/bitbucket-server/readme.md
diff --git a/lib/modules/platform/bitbucket/index.md b/lib/modules/platform/bitbucket/readme.md
similarity index 100%
rename from lib/modules/platform/bitbucket/index.md
rename to lib/modules/platform/bitbucket/readme.md
diff --git a/lib/modules/platform/codecommit/index.md b/lib/modules/platform/codecommit/readme.md
similarity index 100%
rename from lib/modules/platform/codecommit/index.md
rename to lib/modules/platform/codecommit/readme.md
diff --git a/lib/modules/platform/gitea/index.md b/lib/modules/platform/gitea/readme.md
similarity index 100%
rename from lib/modules/platform/gitea/index.md
rename to lib/modules/platform/gitea/readme.md
diff --git a/lib/modules/platform/gitlab/index.md b/lib/modules/platform/gitlab/readme.md
similarity index 100%
rename from lib/modules/platform/gitlab/index.md
rename to lib/modules/platform/gitlab/readme.md
diff --git a/lib/modules/platform/local/index.md b/lib/modules/platform/local/readme.md
similarity index 100%
rename from lib/modules/platform/local/index.md
rename to lib/modules/platform/local/readme.md
diff --git a/tools/docs/platforms.ts b/tools/docs/platforms.ts
index aa83fa273b..9ef8963198 100644
--- a/tools/docs/platforms.ts
+++ b/tools/docs/platforms.ts
@@ -10,7 +10,7 @@ export async function generatePlatforms(
let platformContent = 'Supported values for `platform` are: ';
const platforms = getPlatformList();
for (const platform of platforms) {
- let md = await readFile(`lib/modules/platform/${platform}/index.md`);
+ let md = await readFile(`lib/modules/platform/${platform}/readme.md`);
md += generateFeatureAndBugMarkdown(platformIssuesMap, platform);
--
GitLab