Skip to content

Fix canonical URLs to use direct page paths #4165

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

Open
AlexDaines wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Fix canonical URLs to use direct page paths #4165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docgenerator/SDKDocGeneratorLib/Writers/BaseWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,10 @@ public void Write()
writer.WriteLine("<meta name=\"description\" content=\"{0}\">", GetTitle());
writer.WriteLine("<title>{0} | AWS SDK for .NET Version 4</title>", GetTitle());
writer.WriteLine("<script type=\"text/javascript\" src=\"/assets/js/awsdocs-boot.js\"></script>");
writer.WriteLine("<link rel=\"canonical\" href=\"https://docs.aws.amazon.com/sdkfornet/v4/apidocs/index.html?page={0}&tocid={1}\"/>",
FilenameGenerator.Escape(this.GenerateFilename()),
FilenameGenerator.Escape(this.GetTOCID()));
writer.WriteLine("<meta name=\"aws-tocid\" content=\"{0}\"/>", FilenameGenerator.Escape(this.GetTOCID()));
writer.WriteLine("<link rel=\"canonical\" href=\"https://docs.aws.amazon.com/sdkfornet/v4/apidocs/items/{0}/{1}\"/>",
FilenameGenerator.Escape(this.GenerateFilepath()),
FilenameGenerator.Escape(this.GenerateFilename()));

writer.WriteLine("</head>");

Expand Down
38 changes: 14 additions & 24 deletions docgenerator/SDKDocGeneratorLib/output-files/resources/parentloader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,21 @@
}
}
else {
//This content page is not in the expected frameset which contains the TOC so
//reload the parent frame and cause it to reload this page in the frame. The
//canonical link element contains the link to reload the entire parent frameset
//and load this current content page.
var pageLink = jQuery("link[rel='canonical']").attr('href');
if (pageLink !== '') {
//Canonical links look like this: http://docs.aws.amazon.com/sdkfornet/v4/apidocs/index.html?page=PAGE.html&tocid=TOCID
//Attempt to find where the relative path starts after the hostname.
var seekFrom = 0;
var protocolEndIndex = pageLink.indexOf('://');
if (protocolEndIndex != -1) {
seekFrom = protocolEndIndex + 3;
}
//This content page is not in the expected frameset which contains the TOC so
//reload the parent frame and cause it to reload this page in the frame.
//Read the tocid from the meta tag and build the frameset URL.
var tocid = jQuery("meta[name='aws-tocid']").attr('content');
var pathname = window.location.pathname;
var itemsIndex = pathname.indexOf('/items/');

//Look for the start of the relative path.
var relPathIndex = pageLink.indexOf('/', seekFrom);
if (relPathIndex != -1) {
//Reload the parent frameset and this content page. Note the address bar URL will
//look like the canonical link in the address bar. The inFrame part of this script
//will run on release to replace the address bar URL with the actual friendly content
//frame page URL.
window.location.href = pageLink.substring(relPathIndex);
}
//Else do nothing because the link doesn't appear to be in a normal URL format where the
//hostname ends with a / starting the relative URL path.
if (tocid && itemsIndex !== -1) {
Copy link
Contributor

@peterrsongg peterrsongg Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so what happens if we don't get into this if statement? we dont set the window.location.href? Is that ever a valid case?

Copy link
Contributor Author

@AlexDaines AlexDaines Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. This is the same behavior as the original code. It also had some cases where it would just not redirect (if the canonical url was empty or it couldnt parse the path etc.) . If we cant determine the tocid or path, the page just displays without the frameset which is not a huge deal. Content is still there just without the table of contents sidebar.

//Build the frameset URL from the current path
var basePath = pathname.substring(0, itemsIndex);
var filename = pathname.substring(pathname.lastIndexOf('/') + 1);
//Reload the parent frameset and this content page. The inFrame part of this script
//will run on reload to replace the address bar URL with the actual friendly content
//frame page URL.
window.location.href = basePath + '/index.html?page=' + filename + '&tocid=' + tocid;
}
}
})();