From 4809dbdc23d7b4921f37ab942cce39e7a9cad393 Mon Sep 17 00:00:00 2001
From: Michael Kriese <michael.kriese@visualon.de>
Date: Mon, 5 Dec 2022 12:57:57 +0100
Subject: [PATCH] docs: new nav (#19188)
---
docs/usage/.pages | 51 +++++++++++++++++++
docs/usage/getting-started/.pages | 7 +++
docs/usage/key-concepts/.pages | 6 +++
docs/usage/modules/.pages | 3 ++
docs/usage/modules/manager/.pages | 9 ++++
.../modules/{manager.md => manager/index.md} | 0
docs/usage/modules/platform/.pages | 7 +++
.../{platform.md => platform/index.md} | 0
docs/usage/user-stories/.pages | 4 ++
tools/docs/manager.ts | 4 +-
tools/docs/platforms.ts | 4 +-
tools/generate-docs.ts | 2 +-
12 files changed, 92 insertions(+), 5 deletions(-)
create mode 100644 docs/usage/.pages
create mode 100644 docs/usage/getting-started/.pages
create mode 100644 docs/usage/key-concepts/.pages
create mode 100644 docs/usage/modules/.pages
create mode 100644 docs/usage/modules/manager/.pages
rename docs/usage/modules/{manager.md => manager/index.md} (100%)
create mode 100644 docs/usage/modules/platform/.pages
rename docs/usage/modules/{platform.md => platform/index.md} (100%)
create mode 100644 docs/usage/user-stories/.pages
diff --git a/docs/usage/.pages b/docs/usage/.pages
new file mode 100644
index 0000000000..4d17ba7266
--- /dev/null
+++ b/docs/usage/.pages
@@ -0,0 +1,51 @@
+nav:
+ - Home: 'index.md'
+ - ... | getting-started
+ - Troubleshooting: 'troubleshooting.md'
+ - Configuration:
+ - 'Self-hosted': 'self-hosted-configuration.md'
+ - 'Repository': 'configuration-options.md'
+ - 'Presets': 'config-presets.md'
+ - ... | key-concepts
+ - ... | modules
+ - Language Support:
+ - 'Bazel': 'bazel.md'
+ - 'Docker': 'docker.md'
+ - 'Golang': 'golang.md'
+ - 'Java': 'java.md'
+ - 'JavaScript': 'javascript.md'
+ - 'Node.js Versions': 'node.md'
+ - 'Nuget': 'nuget.md'
+ - 'PHP': 'php.md'
+ - 'Python': 'python.md'
+ - 'Ruby': 'ruby.md'
+ - Deep Dives:
+ - 'Should you Pin your Javascript Dependencies?': 'dependency-pinning.md'
+ - 'Config Template Editing': 'configuration-templates.md'
+ - 'Updating and Rebasing Branches': 'updating-rebasing.md'
+ - 'Semantic Commit Messages': 'semantic-commits.md'
+ - 'Noise Reduction': 'noise-reduction.md'
+ - Included Presets:
+ - 'Compatibility Presets': 'presets-compatibility.md'
+ - 'Default Presets': 'presets-default.md'
+ - 'Docker Presets': 'presets-docker.md'
+ - 'Full Config Presets': 'presets-config.md'
+ - 'Group Presets': 'presets-group.md'
+ - 'Helper Presets': 'presets-helpers.md'
+ - 'Monorepo Presets': 'presets-monorepo.md'
+ - 'npm Presets': 'presets-npm.md'
+ - 'Package Presets': 'presets-packages.md'
+ - 'Preview Presets': 'presets-preview.md'
+ - 'Regex Manager Presets': 'presets-regexManagers.md'
+ - 'Replacement Presets': 'presets-replacements.md'
+ - 'Schedule Presets': 'presets-schedule.md'
+ - 'Workaround Presets': 'presets-workarounds.md'
+ - All Other:
+ - ... | user-stories
+ - 'Security and Permissions': 'security-and-permissions.md'
+ - 'Merge Confidence': 'merge-confidence.md'
+ - 'Templates': 'templates.md'
+ - 'Frequently Asked Questions': 'faq.md'
+ - 'Known Limitations': 'known-limitations.md'
+ - 'Release notes for major versions': 'release-notes-for-major-versions.md'
+ - About Us: 'about-us.md'
diff --git a/docs/usage/getting-started/.pages b/docs/usage/getting-started/.pages
new file mode 100644
index 0000000000..d2a1b5c2af
--- /dev/null
+++ b/docs/usage/getting-started/.pages
@@ -0,0 +1,7 @@
+title: Getting Started
+nav:
+ - 'Use Cases': 'use-cases.md'
+ - 'Running Renovate': 'running.md'
+ - 'Self-Hosting Examples': '/examples/self-hosting'
+ - 'Installing & Onboarding': 'installing-onboarding.md'
+ - 'Private Packages': 'private-packages.md'
diff --git a/docs/usage/key-concepts/.pages b/docs/usage/key-concepts/.pages
new file mode 100644
index 0000000000..b6ede935c1
--- /dev/null
+++ b/docs/usage/key-concepts/.pages
@@ -0,0 +1,6 @@
+nav:
+ - 'Presets': 'presets.md'
+ - 'Dependency Dashboard': 'dashboard.md'
+ - 'Pull Requests': 'pull-requests.md'
+ - 'Renovate Scheduling': 'scheduling.md'
+ - 'Automerge': 'automerge.md'
diff --git a/docs/usage/modules/.pages b/docs/usage/modules/.pages
new file mode 100644
index 0000000000..74686a6979
--- /dev/null
+++ b/docs/usage/modules/.pages
@@ -0,0 +1,3 @@
+title: Renovate Modules
+order: asc
+sort_type: natural
diff --git a/docs/usage/modules/manager/.pages b/docs/usage/modules/manager/.pages
new file mode 100644
index 0000000000..d94cfae7f8
--- /dev/null
+++ b/docs/usage/modules/manager/.pages
@@ -0,0 +1,9 @@
+title: Managers
+nav:
+ - index.md
+# TODO: add all managers ?
+# - Introduction: index.md
+# - ...
+collapse_single_pages: true
+order: asc
+sort_type: natural
diff --git a/docs/usage/modules/manager.md b/docs/usage/modules/manager/index.md
similarity index 100%
rename from docs/usage/modules/manager.md
rename to docs/usage/modules/manager/index.md
diff --git a/docs/usage/modules/platform/.pages b/docs/usage/modules/platform/.pages
new file mode 100644
index 0000000000..3b36f65fef
--- /dev/null
+++ b/docs/usage/modules/platform/.pages
@@ -0,0 +1,7 @@
+title: Platforms
+nav:
+ - Introduction: index.md
+ - ...
+collapse_single_pages: true
+order: asc
+sort_type: natural
diff --git a/docs/usage/modules/platform.md b/docs/usage/modules/platform/index.md
similarity index 100%
rename from docs/usage/modules/platform.md
rename to docs/usage/modules/platform/index.md
diff --git a/docs/usage/user-stories/.pages b/docs/usage/user-stories/.pages
new file mode 100644
index 0000000000..328263cc25
--- /dev/null
+++ b/docs/usage/user-stories/.pages
@@ -0,0 +1,4 @@
+title: User Stories
+nav:
+ - 'Swissquote': 'swissquote.md'
+
diff --git a/tools/docs/manager.ts b/tools/docs/manager.ts
index f8bd25c232..3884560f7b 100644
--- a/tools/docs/manager.ts
+++ b/tools/docs/manager.ts
@@ -212,7 +212,7 @@ sidebar_label: ${displayName}
languageText += allLanguages[language].map(getManagerLink).join(', ');
languageText += '\n\n';
}
- let indexContent = await readFile(`docs/usage/modules/manager.md`);
+ let indexContent = await readFile(`docs/usage/modules/manager/index.md`);
indexContent = replaceContent(indexContent, languageText);
- await updateFile(`${dist}/modules/manager.md`, indexContent);
+ await updateFile(`${dist}/modules/manager/index.md`, indexContent);
}
diff --git a/tools/docs/platforms.ts b/tools/docs/platforms.ts
index 728fd768ed..a185c5a14e 100644
--- a/tools/docs/platforms.ts
+++ b/tools/docs/platforms.ts
@@ -20,8 +20,8 @@ export async function generatePlatforms(dist: string): Promise<void> {
platformContent += '.\n';
- const indexFileName = `docs/usage/modules/platform.md`;
+ const indexFileName = `docs/usage/modules/platform/index.md`;
let indexContent = await readFile(indexFileName);
indexContent = replaceContent(indexContent, platformContent);
- await updateFile(`${dist}/modules/platform.md`, indexContent);
+ await updateFile(`${dist}/modules/platform/index.md`, indexContent);
}
diff --git a/tools/generate-docs.ts b/tools/generate-docs.ts
index 612f917d5a..d4434bf67d 100644
--- a/tools/generate-docs.ts
+++ b/tools/generate-docs.ts
@@ -31,7 +31,7 @@ process.on('unhandledRejection', (err) => {
}
logger.info('* static');
- r = shell.cp('-r', 'docs/usage/*', `${dist}/`);
+ r = shell.cp('-r', 'docs/usage/.', `${dist}`);
if (r.code) {
return;
}
--
GitLab