Naming refactor, cleanup and docs

Author: reakaleek

src/Elastic.Documentation.LegacyDocs/BloomFilter.cs

@@ -6,9 +6,9 @@
 using System.Security.Cryptography;
 using System.Text;
 
-namespace Elastic.Documentation.LegacyPageLookup;
+namespace Elastic.Documentation.LegacyDocs;
 
-public class BloomFilter
+internal sealed class BloomFilter
 {
 	/// <summary>
 	/// The bit array for the filter.

src/Elastic.Documentation.LegacyDocs/Elastic.Documentation.LegacyDocs.csproj

@@ -2,9 +2,10 @@
 
     <PropertyGroup>
         <TargetFramework>net9.0</TargetFramework>
+        <OutputType>Library</OutputType>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
-        <RootNamespace>Elastic.Documentation.LegacyPageLookup</RootNamespace>
+        <RootNamespace>Elastic.Documentation.LegacyDocs</RootNamespace>
     </PropertyGroup>
 
     <ItemGroup>

src/Elastic.Documentation.LegacyDocs/LegacyPageChecker.cs

@@ -5,9 +5,9 @@
 using System.IO.Abstractions;
 using Elastic.Documentation.Configuration;
 
-namespace Elastic.Documentation.LegacyPageLookup;
+namespace Elastic.Documentation.LegacyDocs;
 
-public class LegacyPageLookup(IFileSystem fs)
+public class LegacyPageChecker(IFileSystem fs)
 {
 	private BloomFilter? _bloomFilter;
 	private readonly string _bloomFilterBinaryPath = Path.Combine(Paths.WorkingDirectoryRoot.FullName, "src", "Elastic.Documentation.LegacyDocs", "legacy-pages.bloom.bin");

src/Elastic.Documentation.LegacyDocs/PagesProvider.cs

@@ -2,10 +2,7 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
-
-using Elastic.Documentation.Configuration;
-
-namespace Elastic.Documentation.LegacyPageLookup;
+namespace Elastic.Documentation.LegacyDocs;
 
 public interface IPagesProvider
 {

src/Elastic.Documentation.LegacyDocs/README.md

@@ -0,0 +1,16 @@
+# Legacy Docs
+
+## Legacy Page Checker
+
+The legacy page checker is a tool that checks if an URL exists in the legacy docs system (https://www.elastic.co/guide).
+It uses a checked-in bloom filter file loaded into memory to check if an URL exists.
+
+### How to create or update the bloom filter file
+
+The bloom filter file is created by running the following command:
+
+```
+dotnet run --project src/tooling/docs-assembler -- legacy-docs create-bloom-bin --built-docs-dir /path/to/elastic/built-docs
+```
+
+1. The `--built-docs-dir` option is the path to the locally checked-out [elastic/built-docs](https://github.com/elastic/built-docs) repository.

src/Elastic.Markdown/Slices/HtmlWriter.cs

@@ -6,7 +6,6 @@
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration.Builder;
 using Elastic.Documentation.Legacy;
-using Elastic.Documentation.LegacyPageLookup;
 using Elastic.Documentation.Site.FileProviders;
 using Elastic.Documentation.Site.Navigation;
 using Elastic.Markdown.Extensions.DetectionRules;

src/tooling/Elastic.Documentation.Tooling/Elastic.Documentation.Tooling.csproj

@@ -10,7 +10,7 @@
     <PackageReference Include="ConsoleAppFramework.Abstractions" />
     <PackageReference Include="Microsoft.Extensions.Logging" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" />
-    <PackageReference Include="Github.Actions.Core" />
+    <PackageReference Include="GitHub.Actions.Core" />
     <PackageReference Include="Crayon" />
     <PackageReference Include="Errata" />
   </ItemGroup>

src/tooling/docs-assembler/Cli/LegacyDocsCommands.cs

@@ -6,8 +6,7 @@
 using System.IO.Abstractions;
 using Actions.Core.Services;
 using ConsoleAppFramework;
-using Elastic.Documentation.Configuration;
-using Elastic.Documentation.LegacyPageLookup;
+using Elastic.Documentation.LegacyDocs;
 using Elastic.Documentation.Tooling.Diagnostics.Console;
 using Microsoft.Extensions.Logging;
 
@@ -34,7 +33,7 @@ public async Task<int> CreateBloomBin(string builtDocsDir, Cancel ctx = default)
 			NoHints = true
 		}.StartAsync(ctx);
 		var pagesProvider = new LocalPagesProvider(builtDocsDir);
-		var legacyPageLookup = new LegacyPageLookup(new FileSystem());
+		var legacyPageLookup = new LegacyPageChecker(new FileSystem());
 		legacyPageLookup.GenerateBloomFilterBinary(pagesProvider);
 		await collector.StopAsync(ctx);
 		return collector.Errors;
@@ -49,7 +48,7 @@ public async Task<int> PageExists(string path, Cancel ctx = default)
 		{
 			NoHints = true
 		}.StartAsync(ctx);
-		var legacyPageLookup = new LegacyPageLookup(new FileSystem());
+		var legacyPageLookup = new LegacyPageChecker(new FileSystem());
 		var result = legacyPageLookup.PathExists(path);
 		Console.WriteLine(result ? "exists" : "does not exist");
 		await collector.StopAsync(ctx);

src/tooling/docs-assembler/Cli/RepositoryCommands.cs

@@ -15,7 +15,7 @@
 using Documentation.Assembler.Sourcing;
 using Elastic.Documentation.Configuration;
 using Elastic.Documentation.Configuration.Assembler;
-using Elastic.Documentation.LegacyPageLookup;
+using Elastic.Documentation.LegacyDocs;
 using Elastic.Documentation.Tooling.Diagnostics.Console;
 using Elastic.Markdown;
 using Elastic.Markdown.Exporters;
@@ -129,7 +129,7 @@ public async Task<int> BuildAll(
 		var pathProvider = new GlobalNavigationPathProvider(navigationFile, assembleSources, assembleContext);
 		var htmlWriter = new GlobalNavigationHtmlWriter(navigationFile, assembleContext, navigation, assembleSources);
 
-		var historyMapper = new PageLegacyUrlMapper(new LegacyPageLookup(new FileSystem()), assembleSources.HistoryMappings);
+		var historyMapper = new PageLegacyUrlMapper(new LegacyPageChecker(new FileSystem()), assembleSources.HistoryMappings);
 
 		var builder = new AssemblerBuilder(logger, assembleContext, navigation, htmlWriter, pathProvider, historyMapper);
 		await builder.BuildAllAsync(assembleSources.AssembleSets, exporters, ctx);

src/tooling/docs-assembler/Legacy/PageLegacyUrlMapper.cs

@@ -4,18 +4,18 @@
 
 using System.IO.Abstractions;
 using Elastic.Documentation.Legacy;
-using Elastic.Documentation.LegacyPageLookup;
+using Elastic.Documentation.LegacyDocs;
 
 namespace Documentation.Assembler.Legacy;
 
 public record PageLegacyUrlMapper : ILegacyUrlMapper
 {
 	private IReadOnlyDictionary<string, IReadOnlyCollection<string>> PreviousUrls { get; }
-	private LegacyPageLookup LegacyPageLookup { get; }
-	public PageLegacyUrlMapper(LegacyPageLookup legacyPageLookup, IReadOnlyDictionary<string, IReadOnlyCollection<string>> previousUrls)
+	private LegacyPageChecker LegacyPageChecker { get; }
+	public PageLegacyUrlMapper(LegacyPageChecker legacyPageChecker, IReadOnlyDictionary<string, IReadOnlyCollection<string>> previousUrls)
 	{
 		PreviousUrls = previousUrls;
-		LegacyPageLookup = legacyPageLookup;
+		LegacyPageChecker = legacyPageChecker;
 	}
 
 	public IReadOnlyCollection<LegacyPageMapping> MapLegacyUrl(IReadOnlyCollection<string>? mappedPages)
@@ -41,7 +41,7 @@ public IReadOnlyCollection<LegacyPageMapping> MapLegacyUrl(IReadOnlyCollection<s
 				{
 					var legacyPageMapping = new LegacyPageMapping(mappedPage, v, true);
 					var path = Uri.TryCreate(legacyPageMapping.ToString(), UriKind.Absolute, out var uri) ? uri : null;
-					var exists = LegacyPageLookup.PathExists(path?.AbsolutePath!);
+					var exists = LegacyPageChecker.PathExists(path?.AbsolutePath!);
 					return legacyPageMapping with { Exists = exists };
 				}
 			).ToArray();