-
Notifications
You must be signed in to change notification settings - Fork 31
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.
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
don't use 'current' for doc links #808
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ object Dependencies { | |
val PekkoGrpcBinaryVersion = "1.1" | ||
val PekkoHttpVersion = PekkoHttpDependency.version | ||
val PekkoStreamsCirceVersion = "1.1.0" | ||
val PekkoHttpBinaryVersion = "1.0" | ||
val PekkoHttpBinaryVersion = PekkoHttpVersion.take(3) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe
? |
||
val ScalaTestVersion = "3.2.19" | ||
val TestContainersScalaTestVersion = "0.41.4" | ||
val mockitoVersion = "4.11.0" // check even https://github.com/scalatest/scalatestplus-mockito/releases | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that I think about it more, I'm no longer sure that it's better to link to the the Pekko version this is built against than the 'current' Pekko version: because of binary compatibility it'll be common and recommended that people use newer versions of Pekko with older versions of satellite libraries.
I'm not opposed though :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea is to point to the docs of the lib based on the version of that lib that we build with. As we have seen with the Pekko core docs and the redirect of current from 1.0 to 1.1 broke some links. This approach of not linking to current means things are more stable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should avoid that in the future by leaving behind redirects, though: while changing our own sites to link to specific version indeed avoids some breakage, there might still be external links pointing to 'current'. It might also be better for SEO. Additionally, in Akka we often noticed people being confused because they were referring to outdated versions of the docs.
Having said that, I'm still OK with the change to the versioned docs - just wanted to share my thoughts for consideration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've already pushed similar changes into other Pekko repos so I would like to stay consistent. We can always review the strategy again later.
The Akka docs have a feature to warn you if you are viewing old docs and provides a link to the latest docs. We could try to do something similar. One approach would be for legacy branches (eg 1.0.x branches) to be modified to put a header on all pages that provides a link to the
current
version of that page.