Scaladoc: support setting canonical URLs #7834
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduces a new command line flag for Scaladoc to configure a base URL for generation of canonical URLs on all pages. Canonical URLs intend to help search engines to identify the most relevant/recent version of a page when several versions are available. References [Google Support: Consolidate duplicate URLs](https://support.google.com/webmasters/answer/139066?hl=en) [Blog: Google’s Algorithms Can Ignore Rel Canonical When URLs Contain Different Content.](https://www.gsqi.com/marketing-blog/google-ignore-rel-canonical-different-content/) Fixes scala/bug#10640
adriaanm
reviewed
Mar 8, 2019
| val canonicalLink = if (canonicalSetting.isSetByUser) { | ||
| val canonicalUrl = | ||
| if (canonicalSetting.value.endsWith("/")) canonicalSetting.value | ||
| else canonicalSetting.value + "/" |
There was a problem hiding this comment.
is this normalization to end with a "/" always desired?
There was a problem hiding this comment.
The path to the actual page gets appended, so yes.
https://github.com/scala/scala/pull/7834/files#diff-789c4c9e5fea2476bc65c256a0449572R53
diesalbla
added
the
tool:scaladoc
|
@ennru Is this one ready to go? Can it be backported to |
|
Yes, this is ready to be merged. If there are not other comments. |
|
Sorry about the delay, this is fine to merge for the RC cycle. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a new command line flag for Scaladoc to configure a base URL for generation of canonical URLs on all pages.
Canonical URLs intend to help search engines to identify the most relevant/recent version of a page when several versions are available.
References
Google Support: Consolidate duplicate URLs
Blog: Google’s Algorithms Can Ignore Rel Canonical When URLs Contain Different Content.
Fixes scala/bug#10640