Merge branch 'main' into feature/versions

# Conflicts:
#	src/Elastic.ApiExplorer/Endpoints/EndpointView.cshtml
#	src/Elastic.ApiExplorer/Landing/LandingView.cshtml
#	src/Elastic.ApiExplorer/Operations/OperationView.cshtml
#	src/Elastic.Documentation.Site/_ViewModels.cs
#	src/Elastic.Markdown/Slices/Index.cshtml

Author: reakaleek

.github/workflows/smoke-test.yml

@@ -39,3 +39,8 @@ jobs:
       
       - name: Verify landing-page-path output
         run: test ${{ steps.docs-build.outputs.landing-page-path }} == ${{ matrix.landing-page-path-output }}
+
+      - name: Verify link validation
+        run: |
+          dotnet run --project src/tooling/docs-builder -- inbound-links validate-link-reference -p test-repo
+      

docs/contribute/locally.md

@@ -39,6 +39,11 @@ This guide uses the first option. If you'd like to clone the repository and buil
    ```
 
    This downloads the latest binary, makes it executable, and installs it to your user PATH.
+   You can optionally specify a specific version to install:
+
+   ```sh
+   DOCS_BUILDER_VERSION=0.40.0 curl -sL https://ela.st/docs-builder-install | sh
+   ```
 
    To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
 
@@ -68,6 +73,11 @@ If you get a `Permission denied` error, make sure that you aren't trying to run
    ```
 
    This downloads the latest binary, makes it executable, and installs it to your user PATH.
+   You can optionally specify a specific version to install:
+
+   ```powershell
+   $env:DOCS_BUILDER_VERSION = '0.40.0'; iwr -useb https://ela.st/docs-builder-install.ps1 | iex
+   ```
 
    To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
 

docs/syntax/frontmatter.md

@@ -61,6 +61,7 @@ The products frontmatter is a list of objects, each object has an `id` field.
 | `cloud-terraform`                           | Elastic Cloud Terraform                       |
 | `ecs`                                       | Elastic Common Schema (ECS)                   |
 | `ecs-logging`                               | ECS Logging                                   |
+| `edot-cf`                                   | EDOT Cloud Forwarder                          |
 | `edot-sdk`                                  | Elastic Distribution of OpenTelemetry SDK     |
 | `edot-collector`                            | Elastic Distribution of OpenTelemetry Collector |
 | `elastic-agent`                             | Elastic Agent                                 |

install.ps1

@@ -1,9 +1,12 @@
 # PowerShell script to install docs-builder binary
 
 # Use AppData\Local for user-specific installation instead of Program Files
-$targetDir = Join-Path -Path $env:LOCALAPPDATA -ChildPath "docs-builder"
+$targetDir  = Join-Path -Path $env:LOCALAPPDATA -ChildPath "docs-builder"
 $targetPath = Join-Path -Path $targetDir -ChildPath "docs-builder.exe"
 
+$version = $env:DOCS_BUILDER_VERSION
+if (-not $version) { $version = 'latest' }
+
 # Check if docs-builder already exists
 if (Test-Path -Path $targetPath) {
     Write-Host "docs-builder is already installed."
@@ -20,10 +23,15 @@ if (-not (Test-Path -Path $targetDir)) {
     New-Item -ItemType Directory -Path $targetDir -Force | Out-Null
 }
 
-# Download the latest Windows binary from releases
+if ($version -eq 'latest') {
+    $downloadUrl = "https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-win-x64.zip"
+} else {
+    $downloadUrl = "https://github.com/elastic/docs-builder/releases/download/$version/docs-builder-win-x64.zip"
+}
+
 $tempZipPath = "$env:TEMP\docs-builder-win-x64.zip"
 Write-Host "Downloading docs-builder binary..."
-Invoke-WebRequest -Uri "https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-win-x64.zip" -OutFile $tempZipPath
+Invoke-WebRequest -Uri $downloadUrl -OutFile $tempZipPath
 
 # Create a temporary directory for extraction
 $tempExtractPath = "$env:TEMP\docs-builder-extract"
@@ -53,8 +61,8 @@ if ($currentPath -notlike "*$targetDir*") {
 }
 
 # Clean up temporary files
-Remove-Item -Path $tempZipPath -Force
+Remove-Item -Path $tempZipPath    -Force
 Remove-Item -Path $tempExtractPath -Recurse -Force
 
-Write-Host "docs-builder has been installed successfully and is available in your PATH."
-Write-Host "You may need to restart your terminal or PowerShell session for the PATH changes to take effect."
+Write-Host "docs-builder ($version) has been installed successfully and is available in your PATH."
+Write-Host "You may need to restart your terminal or PowerShell session for the PATH changes to take effect."

install.sh

@@ -12,6 +12,8 @@ elif [ "$ARCH" = "aarch64" ] || [ "$ARCH" = "arm64" ]; then
   ARCH="arm64"
 fi
 
+VERSION="${DOCS_BUILDER_VERSION:-latest}"
+
 # Determine binary to download based on OS
 if [ "$OS" = "darwin" ]; then
   BINARY="docs-builder-mac-$ARCH.zip"
@@ -55,8 +57,14 @@ fi
 
 echo "Downloading docs-builder for $OS/$ARCH..."
 
+if [ "$VERSION" = "latest" ]; then
+  DOWNLOAD_URL="https://github.com/elastic/docs-builder/releases/latest/download/$BINARY"
+else
+  DOWNLOAD_URL="https://github.com/elastic/docs-builder/releases/download/$VERSION/$BINARY"
+fi
+
 # Download the appropriate binary
-if ! curl -LO "https://github.com/elastic/docs-builder/releases/latest/download/$BINARY"; then
+if ! curl -LO "$DOWNLOAD_URL"; then
   echo "Error: Failed to download $BINARY. Please check your internet connection."
   exit 1
 fi
@@ -87,5 +95,5 @@ fi
 # Clean up the downloaded zip file
 rm -f "$BINARY"
 
-echo "docs-builder has been installed successfully and is available in your PATH."
-echo "You can run 'docs-builder --help' to see available commands."
+echo "docs-builder ($VERSION) has been installed successfully and is available in your PATH."
+echo "You can run 'docs-builder --help' to see available commands."

src/Elastic.ApiExplorer/Endpoints/ApiEndpoint.cs

@@ -58,10 +58,13 @@ public EndpointNavigationItem(int depth, string url, ApiEndpoint apiEndpoint, La
 	public ApiEndpoint Index { get; }
 	public string Url { get; }
 	public string NavigationTitle { get; }
+	public bool Hidden => false;
 
 	public IReadOnlyCollection<OperationNavigationItem> NavigationItems { get; set; } = [];
 
 	public INodeNavigationItem<INavigationModel, INavigationItem> NavigationRoot { get; }
 
 	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; }
+
+	public int NavigationIndex { get; set; }
 }

src/Elastic.ApiExplorer/Endpoints/EndpointView.cshtml

@@ -7,26 +7,15 @@
 	{
 		DocSetName = "Api Explorer",
 		Description = "",
-		Layout = null,
-		PageTocItems = [],
 		CurrentNavigationItem = Model.CurrentNavigationItem,
 		Previous = null,
 		Next = null,
 		NavigationHtml = Model.NavigationHtml,
-		LegacyPages = [],
-		CurrentVersion = null,
-		VersionDropdown = null,
 		UrlPathPrefix = null,
-		GithubEditUrl = null,
-		ReportIssueUrl = null,
 		AllowIndexing = false,
 		CanonicalBaseUrl = null,
 		GoogleTagManager = new GoogleTagManagerConfiguration(),
 		Features = new FeatureFlags([]),
-		Parents =
-		[
-		],
-		Products = null,
 		StaticFileContentHashProvider = Model.StaticFileContentHashProvider
 	};
 }

src/Elastic.ApiExplorer/Landing/LandingNavigationItem.cs

@@ -34,8 +34,10 @@ public class LandingNavigationItem : INodeNavigationItem<ApiLanding, EndpointNav
 	public int Depth { get; }
 	public ApiLanding Index { get; }
 	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; }
+	public int NavigationIndex { get; set; }
 	public IReadOnlyCollection<EndpointNavigationItem> NavigationItems { get; set; } = [];
 	public string Url { get; }
+	public bool Hidden => false;
 
 	//TODO
 	public string NavigationTitle { get; } = "API Documentation";

src/Elastic.ApiExplorer/Landing/LandingView.cshtml

@@ -7,26 +7,15 @@
 	{
 		DocSetName = "Api Explorer",
 		Description = "",
-		Layout = null,
-		PageTocItems = [],
 		CurrentNavigationItem = Model.CurrentNavigationItem,
 		Previous = null,
 		Next = null,
 		NavigationHtml = Model.NavigationHtml,
-		LegacyPages = [],
-		CurrentVersion = null,
-		VersionDropdown = null,
 		UrlPathPrefix = null,
-		GithubEditUrl = null,
-		ReportIssueUrl = null,
 		AllowIndexing = false,
 		CanonicalBaseUrl = null,
 		GoogleTagManager = new GoogleTagManagerConfiguration(),
 		Features = new FeatureFlags([]),
-		Parents =
-		[
-		],
-		Products = null,
 		StaticFileContentHashProvider = Model.StaticFileContentHashProvider
 	};
 }

src/Elastic.ApiExplorer/Operations/OperationNavigationItem.cs

@@ -47,8 +47,12 @@ public OperationNavigationItem(int depth, string url, ApiOperation apiOperation,
 	public int Depth { get; }
 	public ApiOperation Model { get; }
 	public string Url { get; }
+	public bool Hidden => false;
 
 	public string NavigationTitle { get; }
 
 	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; }
+
+	public int NavigationIndex { get; set; }
+
 }