Skip to content

Adds apm_docs variable to Kibana link checker #2209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szabosteve merged 9 commits into from
Sep 9, 2021
Merged

Adds apm_docs variable to Kibana link checker #2209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e55df68
Adds apm_get_started variable to Kibana link checker.
szabosteve Sep 3, 2021
32b22b1
Update integtest/spec/all_books_broken_link_detection_spec.rb
szabosteve Sep 3, 2021
973a3c8
Modifies link check for APM_DOCS.
szabosteve Sep 3, 2021
d6b2128
Merge branch 'apm.link.check' of github.com:szabosteve/docs into apm.…
szabosteve Sep 3, 2021
57c5883
Apply suggestions from code review
szabosteve Sep 3, 2021
36c84ce
Update build_docs.pl
szabosteve Sep 6, 2021
6e2c2fb
Update build_docs.pl
szabosteve Sep 6, 2021
0c98b7a
Update build_docs.pl
szabosteve Sep 6, 2021
5276887
Update integtest/spec/all_books_broken_link_detection_spec.rb
szabosteve Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion build_docs.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,12 @@ sub check_kibana_links {
# ${KIBANA_DOCS}canvas.html
# ${PLUGIN_DOCS}repository-s3.html
# ${FLEET_DOCS}fleet-overview.html
# ${APM_DOCS}overview.html

my $extractor = sub {
my $contents = shift;
return sub {
while ( $contents =~ m!`(\$\{(?:baseUrl|ELASTIC.+|KIBANA_DOCS|PLUGIN_DOCS|FLEET_DOCS)\}[^`]+)`!g ) {
while ( $contents =~ m!`(\$\{(?:baseUrl|ELASTIC.+|KIBANA_DOCS|PLUGIN_DOCS|FLEET_DOCS|APM_DOCS)\}[^`]+)`!g ) {
my $path = $1;
$path =~ s/\$\{(?:DOC_LINK_VERSION|urlVersion)\}/$branch/;
# In older versions, the variable `${ELASTIC_DOCS}` referred to
Expand All @@ -371,6 +372,7 @@ sub check_kibana_links {
$path =~ s!\$\{KIBANA_DOCS\}!en/kibana/$branch/!;
$path =~ s!\$\{PLUGIN_DOCS\}!en/elasticsearch/plugins/$branch/!;
$path =~ s!\$\{FLEET_DOCS\}!en/fleet/$branch/!;
$path =~ s!\$\{APM_DOCS\}!en/apm/!;
# Replace the "https://www.elastic.co/guide/" URL prefix so that
# it becomes a file path in the built docs.
$path =~ s!\$\{(?:baseUrl|ELASTIC_WEBSITE_URL)\}guide/!!;
Expand Down
6 changes: 6 additions & 0 deletions integtest/spec/all_books_broken_link_detection_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@
include_examples 'there are broken links in kibana',
'en/fleet/master/not-a-fleet-page.html'
end
describe 'when there is a broken APM link' do
include_context 'there is a kibana link', true,
'${APM_DOCS}not-an-apm-page.html', true
include_examples 'there are broken links in kibana',
'en/apm/not-an-apm-page.html'
end
describe 'when using --keep_hash and --sub_dir together like a PR test' do
describe 'when there is a broken link in one of the books being built' do
convert_before do |src, dest|
Expand Down