-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Improve TLS docs, add javaseref shortcode #637
Conversation
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.
My worry is that users will get lost jumping from their driver to the sync driver and that would cause confusion to the users. So I would prefer it being duplicated.
Most of the documentation is duplicated and then updated to the relevant paths / code examples.
In the future once this is migrated over to the docs team, they will be able to include the content.
Is that something we can do here? Include the content, so theres only one copy but it appears inline with all the languages?
This also reverts commit 1fe5cbf.
The answer is complicated: in theory "yes", in practice "no". Despite I found a way to do so, the approach only works when the Hugo re-generates a page that embeds the content of a different page (this must be related to some sort of internal evaluation order). I created 1fe5cbf to show how it could look like, but we can't really do this. TL;DR The TLS docs are now duplicated again. For the sake of sharing knowledge, below are the possible approaches.
Judging by sections 2.1, 2.2, there is a tiny hope that newer versions of Hugo do not have the problems (at least not the one in section 2.2.), but we are locked at Hugo 0.25. Interestingly, Hugo maintainers do not want to provide a built-in way to embed (duplicates the generated content) or include (no content duplication) content: gohugoio/hugo#247. |
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.
LGTM - thanks for looking into the embedding but I agree duplicating for now seems way easier.
This reverts commit efec5aa.
Formerly #622.
Note that this MR removes the TLS docs duplication and points reactive and Scala driver docs to the Java driver page. TSL docs for the reactive and Scala drivers were missing some relevant sections from the Java driver. By using only a single copy of this documentation, we can be sure that there are no outdated copies.
I installed
hugo
0.25 locally from sources and manually checked that the changes, especially those related to the newjavaseref
, work properly.JAVA-3420