move /docs/source to /docs (#277)

* move /docs/source to /docs * update tests to new paths
elastic · Jan 21, 2025 · 4ae4f03 · 4ae4f03
1 parent 5b7a700
commit 4ae4f03
Show file tree

Hide file tree

Showing 71 changed files with 24 additions and 24 deletions.
diff --git a/...ource/configure/content-set/attributes.md → docs/configure/content-set/attributes.md b/...ource/configure/content-set/attributes.md → docs/configure/content-set/attributes.md
diff --git a/...e/configure/content-set/file-structure.md → docs/configure/content-set/file-structure.md b/...e/configure/content-set/file-structure.md → docs/configure/content-set/file-structure.md
diff --git a/docs/source/configure/content-set/index.md → docs/configure/content-set/index.md b/docs/source/configure/content-set/index.md → docs/configure/content-set/index.md
diff --git a/...ource/configure/content-set/navigation.md → docs/configure/content-set/navigation.md b/...ource/configure/content-set/navigation.md → docs/configure/content-set/navigation.md
diff --git a/docs/source/configure/index.md → docs/configure/index.md b/docs/source/configure/index.md → docs/configure/index.md
diff --git a/docs/source/configure/page.md → docs/configure/page.md b/docs/source/configure/page.md → docs/configure/page.md
diff --git a/docs/source/configure/site/content.md → docs/configure/site/content.md b/docs/source/configure/site/content.md → docs/configure/site/content.md
diff --git a/...igure/site/img/site-level-asciidoctor.png → ...igure/site/img/site-level-asciidoctor.png b/...igure/site/img/site-level-asciidoctor.png → ...igure/site/img/site-level-asciidoctor.png
diff --git a/docs/source/configure/site/index.md → docs/configure/site/index.md b/docs/source/configure/site/index.md → docs/configure/site/index.md
diff --git a/docs/source/configure/site/landing-page.md → docs/configure/site/landing-page.md b/docs/source/configure/site/landing-page.md → docs/configure/site/landing-page.md
diff --git a/docs/source/configure/site/redirects.md → docs/configure/site/redirects.md b/docs/source/configure/site/redirects.md → docs/configure/site/redirects.md
diff --git a/...ource/configure/site/shared-attributes.md → docs/configure/site/shared-attributes.md b/...ource/configure/site/shared-attributes.md → docs/configure/site/shared-attributes.md
diff --git a/docs/source/contribute/index.md → docs/contribute/index.md b/docs/source/contribute/index.md → docs/contribute/index.md
diff --git a/docs/source/contribute/locally.md → docs/contribute/locally.md b/docs/source/contribute/locally.md → docs/contribute/locally.md
diff --git a/docs/source/contribute/on-the-web.md → docs/contribute/on-the-web.md b/docs/source/contribute/on-the-web.md → docs/contribute/on-the-web.md
diff --git a/docs/source/development/index.md → docs/development/index.md b/docs/source/development/index.md → docs/development/index.md
diff --git a/docs/source/development/link-validation.md → docs/development/link-validation.md b/docs/source/development/link-validation.md → docs/development/link-validation.md
diff --git a/docs/source/development/toc.yml → docs/development/toc.yml b/docs/source/development/toc.yml → docs/development/toc.yml
diff --git a/docs/source/docset.yml → docs/docset.yml b/docs/source/docset.yml → docs/docset.yml
diff --git a/docs/source/index.md → docs/index.md b/docs/source/index.md → docs/index.md
diff --git a/docs/source/migration/engineering.md → docs/migration/engineering.md b/docs/source/migration/engineering.md → docs/migration/engineering.md
diff --git a/docs/source/migration/freeze/gh-action.md → docs/migration/freeze/gh-action.md b/docs/source/migration/freeze/gh-action.md → docs/migration/freeze/gh-action.md
diff --git a/docs/source/migration/freeze/index.md → docs/migration/freeze/index.md b/docs/source/migration/freeze/index.md → docs/migration/freeze/index.md
diff --git a/.../source/migration/guide/file-structure.md → docs/migration/guide/file-structure.md b/.../source/migration/guide/file-structure.md → docs/migration/guide/file-structure.md
diff --git a/docs/source/migration/guide/index.md → docs/migration/guide/index.md b/docs/source/migration/guide/index.md → docs/migration/guide/index.md
diff --git a/docs/source/migration/guide/mapping.md → docs/migration/guide/mapping.md b/docs/source/migration/guide/mapping.md → docs/migration/guide/mapping.md
diff --git a/docs/source/migration/ia.md → docs/migration/ia.md b/docs/source/migration/ia.md → docs/migration/ia.md
diff --git a/docs/source/migration/index.md → docs/migration/index.md b/docs/source/migration/index.md → docs/migration/index.md
diff --git a/docs/source/migration/syntax.md → docs/migration/syntax.md b/docs/source/migration/syntax.md → docs/migration/syntax.md
diff --git a/docs/source/migration/versioning.md → docs/migration/versioning.md b/docs/source/migration/versioning.md → docs/migration/versioning.md
diff --git a/...urce/syntax/_snippets/reusable-snippet.md → docs/syntax/_snippets/reusable-snippet.md b/...urce/syntax/_snippets/reusable-snippet.md → docs/syntax/_snippets/reusable-snippet.md
diff --git a/...source/syntax/_snippets/unused-snippet.md → docs/syntax/_snippets/unused-snippet.md b/...source/syntax/_snippets/unused-snippet.md → docs/syntax/_snippets/unused-snippet.md
diff --git a/docs/source/syntax/admonitions.md → docs/syntax/admonitions.md b/docs/source/syntax/admonitions.md → docs/syntax/admonitions.md
diff --git a/docs/source/syntax/applies.md → docs/syntax/applies.md b/docs/source/syntax/applies.md → docs/syntax/applies.md
diff --git a/docs/source/syntax/automated_settings.md → docs/syntax/automated_settings.md b/docs/source/syntax/automated_settings.md → docs/syntax/automated_settings.md
diff --git a/docs/source/syntax/code.md → docs/syntax/code.md b/docs/source/syntax/code.md → docs/syntax/code.md
diff --git a/docs/source/syntax/conditionals.md → docs/syntax/conditionals.md b/docs/source/syntax/conditionals.md → docs/syntax/conditionals.md
diff --git a/docs/source/syntax/dropdowns.md → docs/syntax/dropdowns.md b/docs/source/syntax/dropdowns.md → docs/syntax/dropdowns.md
diff --git a/docs/source/syntax/example_blocks.md → docs/syntax/example_blocks.md b/docs/source/syntax/example_blocks.md → docs/syntax/example_blocks.md
diff --git a/docs/source/syntax/file_inclusion.md → docs/syntax/file_inclusion.md b/docs/source/syntax/file_inclusion.md → docs/syntax/file_inclusion.md
diff --git a/docs/source/syntax/frontmatter.md → docs/syntax/frontmatter.md b/docs/source/syntax/frontmatter.md → docs/syntax/frontmatter.md
diff --git a/docs/source/syntax/images.md → docs/syntax/images.md b/docs/source/syntax/images.md → docs/syntax/images.md
diff --git a/docs/source/syntax/img/apm.png → docs/syntax/img/apm.png b/docs/source/syntax/img/apm.png → docs/syntax/img/apm.png
diff --git a/docs/source/syntax/img/observability.png → docs/syntax/img/observability.png b/docs/source/syntax/img/observability.png → docs/syntax/img/observability.png
diff --git a/...ce/syntax/img/serverless-capabilities.svg → docs/syntax/img/serverless-capabilities.svg b/...ce/syntax/img/serverless-capabilities.svg → docs/syntax/img/serverless-capabilities.svg
diff --git a/docs/source/syntax/index.md → docs/syntax/index.md b/docs/source/syntax/index.md → docs/syntax/index.md
diff --git a/...yntax/kibana-alerting-action-settings.yml → ...yntax/kibana-alerting-action-settings.yml b/...yntax/kibana-alerting-action-settings.yml → ...yntax/kibana-alerting-action-settings.yml
diff --git a/docs/source/syntax/links.md → docs/syntax/links.md b/docs/source/syntax/links.md → docs/syntax/links.md
diff --git a/docs/source/syntax/md-extensions.md → docs/syntax/md-extensions.md b/docs/source/syntax/md-extensions.md → docs/syntax/md-extensions.md
diff --git a/docs/source/syntax/passthrough.md → docs/syntax/passthrough.md b/docs/source/syntax/passthrough.md → docs/syntax/passthrough.md
diff --git a/docs/source/syntax/sidebars.md → docs/syntax/sidebars.md b/docs/source/syntax/sidebars.md → docs/syntax/sidebars.md
diff --git a/docs/source/syntax/substitutions.md → docs/syntax/substitutions.md b/docs/source/syntax/substitutions.md → docs/syntax/substitutions.md
diff --git a/docs/source/syntax/sundries.md → docs/syntax/sundries.md b/docs/source/syntax/sundries.md → docs/syntax/sundries.md
diff --git a/docs/source/syntax/tables.md → docs/syntax/tables.md b/docs/source/syntax/tables.md → docs/syntax/tables.md
diff --git a/docs/source/syntax/tabs.md → docs/syntax/tabs.md b/docs/source/syntax/tabs.md → docs/syntax/tabs.md
diff --git a/docs/source/syntax/tagged_regions.md → docs/syntax/tagged_regions.md b/docs/source/syntax/tagged_regions.md → docs/syntax/tagged_regions.md
diff --git a/docs/source/syntax/titles.md → docs/syntax/titles.md b/docs/source/syntax/titles.md → docs/syntax/titles.md
diff --git a/docs/source/testing/cross-links.md → docs/testing/cross-links.md b/docs/source/testing/cross-links.md → docs/testing/cross-links.md
diff --git a/docs/source/testing/index.md → docs/testing/index.md b/docs/source/testing/index.md → docs/testing/index.md
diff --git a/docs/source/testing/nested/index.md → docs/testing/nested/index.md b/docs/source/testing/nested/index.md → docs/testing/nested/index.md
diff --git a/docs/source/testing/req.md → docs/testing/req.md b/docs/source/testing/req.md → docs/testing/req.md
diff --git a/tests/Elastic.Markdown.Tests/Directives/DirectiveBaseTests.cs b/tests/Elastic.Markdown.Tests/Directives/DirectiveBaseTests.cs
@@ -58,7 +58,7 @@ protected DirectiveTest(ITestOutputHelper output, [LanguageInjection("markdown")
 
 		FileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
 		{
-			{ "docs/source/index.md", new MockFileData(documentContents) }
+			{ "docs/index.md", new MockFileData(documentContents) }
 		}, new MockFileSystemOptions
 		{
 			CurrentDirectory = Paths.Root.FullName
@@ -67,7 +67,7 @@ protected DirectiveTest(ITestOutputHelper output, [LanguageInjection("markdown")
 		// nasty but sub implementations won't use class state.
 		AddToFileSystem(FileSystem);
 
-		var root = FileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, "docs/source"));
+		var root = FileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, "docs/"));
 		FileSystem.GenerateDocSetYaml(root);
 
 		Collector = new TestDiagnosticsCollector(output);
@@ -76,7 +76,7 @@ protected DirectiveTest(ITestOutputHelper output, [LanguageInjection("markdown")
 			Collector = Collector
 		};
 		Set = new DocumentationSet(context);
-		File = Set.GetMarkdownFile(FileSystem.FileInfo.New("docs/source/index.md")) ?? throw new NullReferenceException();
+		File = Set.GetMarkdownFile(FileSystem.FileInfo.New("docs/index.md")) ?? throw new NullReferenceException();
 		Html = default!; //assigned later
 		Document = default!;
 	}

diff --git a/tests/Elastic.Markdown.Tests/Directives/ImageTests.cs b/tests/Elastic.Markdown.Tests/Directives/ImageTests.cs
@@ -20,7 +20,7 @@ public class ImageBlockTests(ITestOutputHelper output) : DirectiveTest<ImageBloc
 )
 {
 	protected override void AddToFileSystem(MockFileSystem fileSystem) =>
-		fileSystem.AddFile(@"docs/source/img/observability.png", "");
+		fileSystem.AddFile(@"docs/img/observability.png", "");
 
 	[Fact]
 	public void ParsesBlock() => Block.Should().NotBeNull();

diff --git a/tests/Elastic.Markdown.Tests/FileInclusion/IncludeTests.cs b/tests/Elastic.Markdown.Tests/FileInclusion/IncludeTests.cs
@@ -23,7 +23,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello world*";
-		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.md", inclusion);
 	}
 
 	[Fact]
@@ -53,7 +53,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello {{foo}}*";
-		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.md", inclusion);
 	}
 
 	[Fact]
@@ -126,7 +126,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello world*";
-		fileSystem.AddFile(@"docs/source/test.md", inclusion);
+		fileSystem.AddFile(@"docs/test.md", inclusion);
 	}
 
 	[Fact]
@@ -162,7 +162,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 :::{include} test.md
 :::
 """;
-		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.md", inclusion);
 	}
 
 	[Fact]

diff --git a/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs b/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs
@@ -23,7 +23,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello world*";
-		fileSystem.AddFile(@"docs/source/_snippets/test.txt", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.txt", inclusion);
 	}
 
 	[Fact]
@@ -48,7 +48,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello world*";
-		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.md", inclusion);
 	}
 
 	[Fact]

diff --git a/tests/Elastic.Markdown.Tests/Inline/AnchorLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/AnchorLinkTests.cs
@@ -36,8 +36,8 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 
 These are new requirements
 """;
-		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
-		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
+		fileSystem.AddFile(@"docs/testing/req.md", inclusion);
+		fileSystem.AddFile(@"docs/_static/img/observability.png", new MockFileData(""));
 	}
 
 }

diff --git a/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs
@@ -34,8 +34,8 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 This is a 'important' admonition
 :::
 """;
-		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
-		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
+		fileSystem.AddFile(@"docs/testing/req.md", inclusion);
+		fileSystem.AddFile(@"docs/_static/img/observability.png", new MockFileData(""));
 	}
 
 }

diff --git a/tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs
@@ -25,8 +25,8 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 
 To follow this tutorial you will need to install the following components:
 """;
-		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
-		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
+		fileSystem.AddFile(@"docs/testing/req.md", inclusion);
+		fileSystem.AddFile(@"docs/_static/img/observability.png", new MockFileData(""));
 	}
 
 }

diff --git a/tests/Elastic.Markdown.Tests/Inline/InlneBaseTests.cs b/tests/Elastic.Markdown.Tests/Inline/InlneBaseTests.cs
@@ -97,7 +97,7 @@ protected InlineTest(
 
 		FileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
 		{
-			{ "docs/source/index.md", new MockFileData(documentContents) }
+			{ "docs/index.md", new MockFileData(documentContents) }
 		}, new MockFileSystemOptions
 		{
 			CurrentDirectory = Paths.Root.FullName
@@ -106,7 +106,7 @@ protected InlineTest(
 		// nasty but sub implementations won't use class state.
 		AddToFileSystem(FileSystem);
 
-		var root = FileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, "docs/source"));
+		var root = FileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, "docs/"));
 		FileSystem.GenerateDocSetYaml(root, globalVariables);
 
 		Collector = new TestDiagnosticsCollector(output);
@@ -115,7 +115,7 @@ protected InlineTest(
 			Collector = Collector
 		};
 		Set = new DocumentationSet(context);
-		File = Set.GetMarkdownFile(FileSystem.FileInfo.New("docs/source/index.md")) ?? throw new NullReferenceException();
+		File = Set.GetMarkdownFile(FileSystem.FileInfo.New("docs/index.md")) ?? throw new NullReferenceException();
 		Html = default!; //assigned later
 		Document = default!;
 	}

diff --git a/tests/Elastic.Markdown.Tests/OutputDirectoryTests.cs b/tests/Elastic.Markdown.Tests/OutputDirectoryTests.cs
@@ -18,8 +18,8 @@ public async Task CreatesDefaultOutputDirectory()
 		var logger = new TestLoggerFactory(output);
 		var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
 		{
-			{ "docs/source/docset.yml", new MockFileData("") },
-			{ "docs/source/index.md", new MockFileData("test") }
+			{ "docs/docset.yml", new MockFileData("") },
+			{ "docs/index.md", new MockFileData("test") }
 		}, new MockFileSystemOptions
 		{
 			CurrentDirectory = Paths.Root.FullName

diff --git a/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs b/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs
@@ -14,13 +14,13 @@ namespace Elastic.Markdown.Tests.SettingsInclusion;
 
 public class IncludeTests(ITestOutputHelper output) : DirectiveTest<SettingsBlock>(output,
 $$"""
-:::{settings} /{{SettingsPath.Replace("docs/source/", "")}}
+:::{settings} /{{SettingsPath.Replace("docs/", "")}}
 :::
 """
 )
 {
 	private static readonly string SettingsPath =
-		"docs/source/syntax/kibana-alerting-action-settings.yml";
+		"docs/syntax/kibana-alerting-action-settings.yml";
 
 	protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
@@ -52,7 +52,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 	{
 		// language=markdown
 		var inclusion = "*Hello world*";
-		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+		fileSystem.AddFile(@"docs/_snippets/test.md", inclusion);
 	}
 
 	[Fact]