From 7c3471eee24b68caf262ad88c09c28484af5146e Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Tue, 28 Jan 2025 08:24:18 +0100 Subject: [PATCH] Move to docs-builder with support for nested toc.yml files (#257) * Move to docs-builder with support for nested toc.yml files * add .artifacts folder to .gitignore * update .gitignore to include .vscode/tasks.json * remove vscode tasks for now --- .gitignore | 6 +++++- deploy-manage/{doset.yml => toc.yml} | 0 docset.yml | 15 +++++++++++++++ elastic-basics/{doset.yml => toc.yml} | 0 explore-analyze/{doset.yml => toc.yml} | 0 extend/{doset.yml => toc.yml} | 0 index.md | 3 +++ manage-data/{doset.yml => toc.yml} | 0 reference/{doset.yml => toc.yml} | 0 solutions/{doset.yml => toc.yml} | 0 troubleshoot/{doset.yml => toc.yml} | 0 whats-new/{doset.yml => toc.yml} | 0 12 files changed, 23 insertions(+), 1 deletion(-) rename deploy-manage/{doset.yml => toc.yml} (100%) create mode 100644 docset.yml rename elastic-basics/{doset.yml => toc.yml} (100%) rename explore-analyze/{doset.yml => toc.yml} (100%) rename extend/{doset.yml => toc.yml} (100%) create mode 100644 index.md rename manage-data/{doset.yml => toc.yml} (100%) rename reference/{doset.yml => toc.yml} (100%) rename solutions/{doset.yml => toc.yml} (100%) rename troubleshoot/{doset.yml => toc.yml} (100%) rename whats-new/{doset.yml => toc.yml} (100%) diff --git a/.gitignore b/.gitignore index 9995d67ea..b223ab335 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,9 @@ # vscode stuff -.vscode/ +.vscode/* +!.vscode/tasks.json + +# docs-builder default output +.artifacts # vs stuff .vs/ diff --git a/deploy-manage/doset.yml b/deploy-manage/toc.yml similarity index 100% rename from deploy-manage/doset.yml rename to deploy-manage/toc.yml diff --git a/docset.yml b/docset.yml new file mode 100644 index 000000000..33d87116e --- /dev/null +++ b/docset.yml @@ -0,0 +1,15 @@ +project: "docs-content" +exclude: + - '_*.md' + - 'README.md' +toc: + - file: index.md + - toc: elastic-basics + - toc: solutions + - toc: manage-data + - toc: explore-analyze + - toc: deploy-manage + - toc: troubleshoot + - toc: extend + - toc: whats-new + - toc: reference \ No newline at end of file diff --git a/elastic-basics/doset.yml b/elastic-basics/toc.yml similarity index 100% rename from elastic-basics/doset.yml rename to elastic-basics/toc.yml diff --git a/explore-analyze/doset.yml b/explore-analyze/toc.yml similarity index 100% rename from explore-analyze/doset.yml rename to explore-analyze/toc.yml diff --git a/extend/doset.yml b/extend/toc.yml similarity index 100% rename from extend/doset.yml rename to extend/toc.yml diff --git a/index.md b/index.md new file mode 100644 index 000000000..7e3097651 --- /dev/null +++ b/index.md @@ -0,0 +1,3 @@ +--- +title: Elastic Documentation +--- \ No newline at end of file diff --git a/manage-data/doset.yml b/manage-data/toc.yml similarity index 100% rename from manage-data/doset.yml rename to manage-data/toc.yml diff --git a/reference/doset.yml b/reference/toc.yml similarity index 100% rename from reference/doset.yml rename to reference/toc.yml diff --git a/solutions/doset.yml b/solutions/toc.yml similarity index 100% rename from solutions/doset.yml rename to solutions/toc.yml diff --git a/troubleshoot/doset.yml b/troubleshoot/toc.yml similarity index 100% rename from troubleshoot/doset.yml rename to troubleshoot/toc.yml diff --git a/whats-new/doset.yml b/whats-new/toc.yml similarity index 100% rename from whats-new/doset.yml rename to whats-new/toc.yml