From 43623f079434016bc790965ce623ce08c36ac7bf Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 25 Mar 2025 21:38:47 +0100 Subject: [PATCH 01/13] test --- build_docs.pl | 1 + lib/ES/Book.pm | 141 ++++++++++++++++++++++++++++++++++++++----------- 2 files changed, 112 insertions(+), 30 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index d32210bb81be..30bae9f5c465 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -567,6 +567,7 @@ sub build_entries { dir => $build, raw_dir => $raw_build, temp_dir => $temp_dir, + url_mappings => 'url_mappings.json', %$entry ); $toc->add_entry( $book->build( $Opts->{rebuild}, $ConfPath ) ); diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 9ef7552154bf..31d123caa806 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -12,62 +12,129 @@ use File::Copy::Recursive qw(fcopy rcopy); use ES::Toc(); use utf8; use List::Util qw(first); +use JSON::PP; + +# Add new function to load URL mappings +sub _load_url_mappings { + my ($self, $json_file) = @_; + return {} unless -f $json_file; + + local $/; + open(my $fh, '<', $json_file) or die "Cannot open $json_file: $!"; + my $json_text = <$fh>; + close($fh); + + return decode_json($json_text); +} + +# Add function to get redirect URL +sub _get_redirect_url { + my ($self, $current_url, $mappings) = @_; + return $mappings->{$current_url} || '../current/index.html'; # Default fallback +} our %Page_Header = ( en => { - old => <<"HEADER", + old => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; A newer version is available. For the latest information, see the -current release documentation. +current release documentation. HEADER - dead => <<"HEADER", + }, + dead => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the -current release documentation. +current release documentation. HEADER - new => <<"HEADER" -This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. + }, + new => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER" +This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER + } }, zh_cn => { - old => <<"HEADER", -你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 + old => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; +你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER - dead => <<"HEADER", -你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 + }, + dead => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; +你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER - new => <<"HEADER" -你当前正在查看的是未发布版本的预览版文档。如果不是你要找的，请点击查看 当前发布版本的文档。 + }, + new => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; +你当前正在查看的是未发布版本的预览版文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER + } }, ja => { - old => <<"HEADER", + old => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; A newer version is available. For the latest information, see the -current release documentation. +current release documentation. HEADER - dead => <<"HEADER", + }, + dead => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the -current release documentation. +current release documentation. HEADER - new => <<"HEADER" -This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. + }, + new => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; +This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER + } }, ko => { - old => <<"HEADER", + old => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; A newer version is available. For the latest information, see the -current release documentation. +current release documentation. HEADER - dead => <<"HEADER", + }, + dead => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the -current release documentation. +current release documentation. HEADER - new => <<"HEADER" -This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. + }, + new => sub { + my ($self, $mappings, $current_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + return <<"HEADER"; +This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER } - + } ); #=================================== @@ -119,10 +186,6 @@ sub new { push @difference, $item unless grep { $item eq $_ } @branches; } - # print "Branches: ", join(", ", @branches), "\n"; - # print "Live: ", join(", ", @$live_branches), "\n"; - # print "Difference: ", join(", ", @difference), "\n"; - my $missing = join ", ", @difference; die "Live branch(es) <$missing> not in in book <$title>" if $difference[0]; @@ -170,6 +233,7 @@ sub new { respect_edit_url_overrides => $respect_edit_url_overrides, suppress_migration_warnings => $args{suppress_migration_warnings} || 0, toc_extra => $args{toc_extra} || '', + url_mappings_file => $args{url_mappings_file} || '', }, $class; } @@ -456,11 +520,28 @@ sub _page_header_text { #=================================== my ( $self, $phrase ) = @_; $phrase ||= ''; - return $Page_Header{ $self->lang }{$phrase} + + my $header_sub = $Page_Header{ $self->lang }{$phrase} || die "No page header available for lang: " . $self->lang . " and phrase: $phrase"; + + # Load URL mappings from JSON file if it exists + my $mappings = $self->_load_url_mappings($self->{url_mappings_file} || 'url_mappings.json'); + + # Get current URL from the context + my $current_url = $self->_get_current_url(); + + # Call the header sub with mappings and current URL + return $header_sub->($self, $mappings, $current_url); +} +#=================================== +sub _get_current_url { +#=================================== + my ($self) = @_; + # Construct the current URL based on the book's context + return sprintf("%s/%s/index.html", $self->prefix, $self->branch_title($self->current)); } #=================================== From 81815b598dfd4568d3ecddbd1e99231101fbe394 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 25 Mar 2025 22:00:27 +0100 Subject: [PATCH 02/13] Add some logging --- lib/ES/Book.pm | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 31d123caa806..9507f47f4191 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -30,7 +30,7 @@ sub _load_url_mappings { # Add function to get redirect URL sub _get_redirect_url { my ($self, $current_url, $mappings) = @_; - return $mappings->{$current_url} || '../current/index.html'; # Default fallback + return $mappings->{$current_url} || 'https://www.elastic.co/docs'; # Default fallback } our %Page_Header = ( @@ -38,6 +38,10 @@ our %Page_Header = ( old => sub { my ($self, $mappings, $current_url) = @_; my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + + printf(" - %40.40s: current url", $current_url); + printf(" - %40.40s: redirect url", $redirect_url); + return <<"HEADER"; A newer version is available. For the latest information, see the current release documentation. From 1480d596430685c7b13652505d250e58f498d33c Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 25 Mar 2025 22:24:09 +0100 Subject: [PATCH 03/13] fix logging --- lib/ES/Book.pm | 4 ++-- url_mappings.json | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 url_mappings.json diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 9507f47f4191..18fc25ca7105 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -39,8 +39,8 @@ our %Page_Header = ( my ($self, $mappings, $current_url) = @_; my $redirect_url = $self->_get_redirect_url($current_url, $mappings); - printf(" - %40.40s: current url", $current_url); - printf(" - %40.40s: redirect url", $redirect_url); + printf("current_url: %s\n", $current_url); + printf("redirect_url: %s\n", $redirect_url); return <<"HEADER"; A newer version is available. For the latest information, see the diff --git a/url_mappings.json b/url_mappings.json new file mode 100644 index 000000000000..bda3ba112a2f --- /dev/null +++ b/url_mappings.json @@ -0,0 +1,3 @@ +{ + "https://www.elastic.co/guide/en/elasticsearch/reference/7.17/runtime.html": "https://www.elastic.co/docs" +} From c422167c41627eafbda142e9b05a6bc410470890 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 25 Mar 2025 22:58:05 +0100 Subject: [PATCH 04/13] More logging --- lib/ES/Book.pm | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 18fc25ca7105..e0935d56c5f6 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -544,6 +544,14 @@ sub _page_header_text { sub _get_current_url { #=================================== my ($self) = @_; + + + printf("index: %s\n", $self->index); + printf("title: %s\n", $self->title); + printf("dir: %s\n", $self->dir); + printf("toc: %s\n", $self->toc); + + # Construct the current URL based on the book's context return sprintf("%s/%s/index.html", $self->prefix, $self->branch_title($self->current)); } From 7c91f891be3eaf7108b2d9f9be0055df859ec673 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 25 Mar 2025 23:40:08 +0100 Subject: [PATCH 05/13] test --- lib/ES/Book.pm | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index e0935d56c5f6..1937ac89a16e 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -544,16 +544,9 @@ sub _page_header_text { sub _get_current_url { #=================================== my ($self) = @_; - - - printf("index: %s\n", $self->index); - printf("title: %s\n", $self->title); - printf("dir: %s\n", $self->dir); - printf("toc: %s\n", $self->toc); - - - # Construct the current URL based on the book's context - return sprintf("%s/%s/index.html", $self->prefix, $self->branch_title($self->current)); + my $trimmed_dir = $self->dir; + $trimmed_dir =~ s|^/tmp/docsbuild/target_repo/html/||; + return sprintf("https://www.elastic.co/guide/%s/%s/index.html", $trimmed_dir, $self->branch_title($self->current)); } #=================================== From a3996d7590f1d4fd208e01aae8534c7a44a7b565 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 00:08:14 +0100 Subject: [PATCH 06/13] more logging --- lib/ES/Book.pm | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 1937ac89a16e..0a751caedde1 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -544,6 +544,39 @@ sub _page_header_text { sub _get_current_url { #=================================== my ($self) = @_; + +# sub title { shift->{title} } +# sub dir { shift->{dir} } +# sub prefix { shift->{prefix} } +# sub chunk { shift->{chunk} } +# sub toc { shift->{toc} } +# sub single { shift->{single} } +# sub index { shift->{index} } +# sub branches { shift->{branches} } +# sub branch_title { shift->{branch_titles}->{ shift() } } +# sub current { shift->{current} } +# sub is_multi_version { @{ shift->branches } > 1 } +# sub tags { shift->{tags} } +# sub subject { shift->{subject} } +# sub source { shift->{source} } +# sub lang { shift->{lang} } + + printf("self->title: %s\n", $self->title); + printf("self->dir: %s\n", $self->dir); + printf("self->prefix: %s\n", $self->prefix); + printf("self->chunk: %s\n", $self->chunk); + printf("self->toc: %s\n", $self->toc); + printf("self->single: %s\n", $self->single); + printf("self->index: %s\n", $self->index); + printf("self->branches: %s\n", $self->branches); + printf("self->branch_title: %s\n", $self->branch_title($self->current)); + printf("self->current: %s\n", $self->current); + printf("self->is_multi_version: %s\n", $self->is_multi_version); + printf("self->tags: %s\n", $self->tags); + printf("self->subject: %s\n", $self->subject); + printf("self->source: %s\n", $self->source); + printf("self->lang: %s\n", $self->lang); + my $trimmed_dir = $self->dir; $trimmed_dir =~ s|^/tmp/docsbuild/target_repo/html/||; return sprintf("https://www.elastic.co/guide/%s/%s/index.html", $trimmed_dir, $self->branch_title($self->current)); From 440b5b81c1910291c21ce4fc7bd73346b76c0a7b Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 00:26:17 +0100 Subject: [PATCH 07/13] moar logging --- lib/ES/Book.pm | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 0a751caedde1..6123d24c9ad4 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -367,7 +367,7 @@ sub _build_book { private => $self->private( $branch ), noindex => $self->noindex( $branch ), multi => $self->is_multi_version, - page_header => $self->_page_header($branch), + page_header => $self->_page_header($branch, $first_path($index), $version), section_title => $section_title, subject => $subject, toc => $self->toc, @@ -500,7 +500,7 @@ sub _copy_branch_to_current { #=================================== sub _page_header { #=================================== - my ( $self, $branch ) = @_; + my ( $self, $branch, $index_path, $version ) = @_; return '' unless $self->is_multi_version; my $current = $self->current; @@ -516,13 +516,13 @@ sub _page_header { my $key = $branchidx > $currentidx ? 'old' : 'new'; $key = 'dead' if $key eq 'old' && !grep( /^$branch$/, @{ $self->{live_branches} } ); - return $self->_page_header_text( $key ); + return $self->_page_header_text( $key, $index_path, $version ); } #=================================== sub _page_header_text { #=================================== - my ( $self, $phrase ) = @_; + my ( $self, $phrase, $index_path, $version ) = @_; $phrase ||= ''; my $header_sub = $Page_Header{ $self->lang }{$phrase} @@ -535,6 +535,9 @@ sub _page_header_text { # Get current URL from the context my $current_url = $self->_get_current_url(); + + printf("index_path: %s\n", $index_path); + printf("version: %s\n", $version); # Call the header sub with mappings and current URL return $header_sub->($self, $mappings, $current_url); From 4ca235c5605a33cdd54c47ab652ba250a601a968 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 00:31:24 +0100 Subject: [PATCH 08/13] fix --- lib/ES/Book.pm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 6123d24c9ad4..036f0c3460f7 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -367,7 +367,7 @@ sub _build_book { private => $self->private( $branch ), noindex => $self->noindex( $branch ), multi => $self->is_multi_version, - page_header => $self->_page_header($branch, $first_path($index), $version), + page_header => $self->_page_header($branch, $first_path->file($index), $version), section_title => $section_title, subject => $subject, toc => $self->toc, From 384bae03e60d993e3e2686e7556f006a405db6db Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 00:33:17 +0100 Subject: [PATCH 09/13] ok --- lib/ES/Book.pm | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 036f0c3460f7..80c40fc05fcd 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -367,7 +367,7 @@ sub _build_book { private => $self->private( $branch ), noindex => $self->noindex( $branch ), multi => $self->is_multi_version, - page_header => $self->_page_header($branch, $first_path->file($index), $version), + page_header => $self->_page_header($branch, $first_path-($index), $version), section_title => $section_title, subject => $subject, toc => $self->toc, @@ -392,7 +392,7 @@ sub _build_book { noindex => $self->noindex( $branch ), chunk => $self->chunk, multi => $self->is_multi_version, - page_header => $self->_page_header($branch), + page_header => $self->_page_header($branch, $first_path->file($index), $version), section_title => $section_title, subject => $subject, resource => [$checkout], @@ -516,13 +516,13 @@ sub _page_header { my $key = $branchidx > $currentidx ? 'old' : 'new'; $key = 'dead' if $key eq 'old' && !grep( /^$branch$/, @{ $self->{live_branches} } ); - return $self->_page_header_text( $key, $index_path, $version ); + return $self->_page_header_text( $key, $index_path, $version, $branch ); } #=================================== sub _page_header_text { #=================================== - my ( $self, $phrase, $index_path, $version ) = @_; + my ( $self, $phrase, $index_path, $version, $branch ) = @_; $phrase ||= ''; my $header_sub = $Page_Header{ $self->lang }{$phrase} @@ -538,7 +538,7 @@ sub _page_header_text { printf("index_path: %s\n", $index_path); printf("version: %s\n", $version); - + printf("branch: %s\n", $branch); # Call the header sub with mappings and current URL return $header_sub->($self, $mappings, $current_url); } From 693d65855f0b50f480112fd63672614d4417db4b Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 00:59:44 +0100 Subject: [PATCH 10/13] test --- lib/ES/Book.pm | 70 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 42 insertions(+), 28 deletions(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 80c40fc05fcd..4e97c2c3cc6e 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -29,15 +29,18 @@ sub _load_url_mappings { # Add function to get redirect URL sub _get_redirect_url { - my ($self, $current_url, $mappings) = @_; - return $mappings->{$current_url} || 'https://www.elastic.co/docs'; # Default fallback + my ($self, $current_url, $mappings, $canonical_url) = @_; + # If we have a canonical URL, use that as the redirect URL + return $canonical_url if $canonical_url; + # Otherwise fall back to the mappings or default + return $mappings->{$current_url} || 'https://www.elastic.co/docs'; } our %Page_Header = ( en => { old => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); printf("current_url: %s\n", $current_url); printf("redirect_url: %s\n", $redirect_url); @@ -48,8 +51,8 @@ A newer version is available. For the latest information, see the HEADER }, dead => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the @@ -57,8 +60,8 @@ will be released for this version. For the latest information, see the HEADER }, new => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER" This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER @@ -66,22 +69,22 @@ HEADER }, zh_cn => { old => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; 你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER }, dead => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; 你当前正在查看的是旧版本的文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER }, new => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; 你当前正在查看的是未发布版本的预览版文档。如果不是你要找的，请点击查看 当前发布版本的文档。 HEADER @@ -89,16 +92,16 @@ HEADER }, ja => { old => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; A newer version is available. For the latest information, see the current release documentation. HEADER }, dead => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the @@ -106,8 +109,8 @@ will be released for this version. For the latest information, see the HEADER }, new => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER @@ -115,16 +118,16 @@ HEADER }, ko => { old => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; A newer version is available. For the latest information, see the current release documentation. HEADER }, dead => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the @@ -132,8 +135,8 @@ will be released for this version. For the latest information, see the HEADER }, new => sub { - my ($self, $mappings, $current_url) = @_; - my $redirect_url = $self->_get_redirect_url($current_url, $mappings); + my ($self, $mappings, $current_url, $canonical_url) = @_; + my $redirect_url = $self->_get_redirect_url($current_url, $mappings, $canonical_url); return <<"HEADER"; This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details. HEADER @@ -535,12 +538,23 @@ sub _page_header_text { # Get current URL from the context my $current_url = $self->_get_current_url(); + + # Get canonical URL from the document attributes + my $canonical_url = ''; + if ($index_path && -e $index_path) { + my $content = $index_path->slurp(iomode => '<:encoding(UTF-8)'); + if ($content =~ /($self, $mappings, $current_url); + printf("canonical_url: %s\n", $canonical_url); + + # Call the header sub with mappings, current URL, and canonical URL + return $header_sub->($self, $mappings, $current_url, $canonical_url); } #=================================== From de0feb410d135ed96f2a9aae9d27a0868bf65810 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 01:19:55 +0100 Subject: [PATCH 11/13] test --- lib/ES/Book.pm | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index 4e97c2c3cc6e..cc559826fb40 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -592,6 +592,7 @@ sub _get_current_url { printf("self->tags: %s\n", $self->tags); printf("self->subject: %s\n", $self->subject); printf("self->source: %s\n", $self->source); + printf("source-path: %s\n", $self->source->path); printf("self->lang: %s\n", $self->lang); my $trimmed_dir = $self->dir; From 701a3ae747f9072c6e88ff5847dd2adf39010bbd Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 01:36:23 +0100 Subject: [PATCH 12/13] fix --- lib/ES/Source.pm | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/ES/Source.pm b/lib/ES/Source.pm index 710664166c0c..9cf9849a20ea 100644 --- a/lib/ES/Source.pm +++ b/lib/ES/Source.pm @@ -147,6 +147,7 @@ sub _sources_for_branch { #=================================== sub sources { shift->{sources} } sub temp_dir { shift->{temp_dir} } +sub path { shift->{path} } #=================================== 1; From aaa709f1959f810a8282dea604680ef716899674 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Wed, 26 Mar 2025 01:40:38 +0100 Subject: [PATCH 13/13] test --- lib/ES/Book.pm | 79 +++++++++++++++++++++----------------------------- 1 file changed, 33 insertions(+), 46 deletions(-) diff --git a/lib/ES/Book.pm b/lib/ES/Book.pm index cc559826fb40..c95ed5a7efcf 100644 --- a/lib/ES/Book.pm +++ b/lib/ES/Book.pm @@ -536,22 +536,17 @@ sub _page_header_text { # Load URL mappings from JSON file if it exists my $mappings = $self->_load_url_mappings($self->{url_mappings_file} || 'url_mappings.json'); - # Get current URL from the context - my $current_url = $self->_get_current_url(); + # Get current URL based on context info + my $current_url = $self->_get_current_url($index_path, $version, $branch); # Get canonical URL from the document attributes my $canonical_url = ''; if ($index_path && -e $index_path) { my $content = $index_path->slurp(iomode => '<:encoding(UTF-8)'); - if ($content =~ /($self, $mappings, $current_url, $canonical_url); @@ -560,44 +555,36 @@ sub _page_header_text { #=================================== sub _get_current_url { #=================================== - my ($self) = @_; - -# sub title { shift->{title} } -# sub dir { shift->{dir} } -# sub prefix { shift->{prefix} } -# sub chunk { shift->{chunk} } -# sub toc { shift->{toc} } -# sub single { shift->{single} } -# sub index { shift->{index} } -# sub branches { shift->{branches} } -# sub branch_title { shift->{branch_titles}->{ shift() } } -# sub current { shift->{current} } -# sub is_multi_version { @{ shift->branches } > 1 } -# sub tags { shift->{tags} } -# sub subject { shift->{subject} } -# sub source { shift->{source} } -# sub lang { shift->{lang} } - - printf("self->title: %s\n", $self->title); - printf("self->dir: %s\n", $self->dir); - printf("self->prefix: %s\n", $self->prefix); - printf("self->chunk: %s\n", $self->chunk); - printf("self->toc: %s\n", $self->toc); - printf("self->single: %s\n", $self->single); - printf("self->index: %s\n", $self->index); - printf("self->branches: %s\n", $self->branches); - printf("self->branch_title: %s\n", $self->branch_title($self->current)); - printf("self->current: %s\n", $self->current); - printf("self->is_multi_version: %s\n", $self->is_multi_version); - printf("self->tags: %s\n", $self->tags); - printf("self->subject: %s\n", $self->subject); - printf("self->source: %s\n", $self->source); - printf("source-path: %s\n", $self->source->path); - printf("self->lang: %s\n", $self->lang); - - my $trimmed_dir = $self->dir; - $trimmed_dir =~ s|^/tmp/docsbuild/target_repo/html/||; - return sprintf("https://www.elastic.co/guide/%s/%s/index.html", $trimmed_dir, $self->branch_title($self->current)); + my ($self, $index_path, $version, $branch) = @_; + + # Extract book path component + my $book_path = $self->prefix; + + # Get relative path from index.asciidoc to the current file being processed + my $relative_path = ''; + if ($index_path) { + # If we're processing index.asciidoc, use it directly + if ($index_path->basename eq 'index.asciidoc') { + $relative_path = 'index.html'; + } else { + # Otherwise get the path relative to the book root + my $file_path = $index_path->stringify; + if ($file_path =~ m|/([^/]+?)\.asciidoc$|) { + $relative_path = "$1.html"; + } else { + $relative_path = 'index.html'; # Default fallback + } + } + } else { + $relative_path = 'index.html'; # Default fallback + } + + # Construct the URL using the domain, book path, version and file + return sprintf("https://www.elastic.co/guide/%s/%s/%s", + $book_path, + $version, + $relative_path + ); } #===================================