Reduce visibility of Tranquility documentation#11134
Merged
sthetland merged 3 commits intoapache:masterfrom May 3, 2021
Merged
Reduce visibility of Tranquility documentation#11134sthetland merged 3 commits intoapache:masterfrom
sthetland merged 3 commits intoapache:masterfrom
Conversation
sthetland
changed the title
Co-authored-by: Charles Smith <38529548+techdocsmith@users.noreply.github.com>
jon-wei
approved these changes
May 3, 2021
gianm
added a commit
to gianm/druid
that referenced
this pull request
Jan 18, 2024
index_realtime tasks were removed from the documentation in apache#13107. Even at that time, they weren't really documented per se— just mentioned. They existed solely to support Tranquility, which is an obsolete ingestion method that predates migration of Druid to ASF and is no longer being maintained. Tranquility docs were also de-linked from the sidebars and the other doc pages in apache#11134. Only a stub remains, so people with links to the page can see that it's no longer recommended. index_realtime_appenderator tasks existed in the code base, but were never documented, nor as far as I am aware were they used for any purpose. This patch removes both task types completely, as well as removes all supporting code that was otherwise unused. It also updates the stub doc for Tranquility to be firmer that it is not compatible. (Previously, the stub doc said it wasn't recommended, and pointed out that it is built against an ancient 0.9.2 version of Druid.)
clintropolis
added a commit
that referenced
this pull request
Jun 25, 2024
index_realtime tasks were removed from the documentation in #13107. Even at that time, they weren't really documented per se— just mentioned. They existed solely to support Tranquility, which is an obsolete ingestion method that predates migration of Druid to ASF and is no longer being maintained. Tranquility docs were also de-linked from the sidebars and the other doc pages in #11134. Only a stub remains, so people with links to the page can see that it's no longer recommended. index_realtime_appenderator tasks existed in the code base, but were never documented, nor as far as I am aware were they used for any purpose. This patch removes both task types completely, as well as removes all supporting code that was otherwise unused. It also updates the stub doc for Tranquility to be firmer that it is not compatible. (Previously, the stub doc said it wasn't recommended, and pointed out that it is built against an ancient 0.9.2 version of Druid.) ITUnionQueryTest has been migrated to the new integration tests framework and updated to use Kafka ingestion. Co-authored-by: Gian Merlino <gianmerlino@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Since at least version 0.16.0-incubating we've documented that Druid no longer maintains compatibility with Tranquility.
We should accordingly reduce visibility of Tranquility in the documentation, removing it from the left nav and removing it as one of the streaming ingestion options from the table on the Ingestion overview page.
This PR takes those steps.
Not addressed in this PR, but a potential future step could be to remove the Tranquility page entirely, redirecting to a "Deprecated features" page, where it may be listed.
Also not addressed is at least one reference to Tranquility associated with the
index_realtimetask type. All other references to Tranquility mention that it should not be used for new projects.