From 4ef78de0ad512752a782ae2b506849f294883323 Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Mon, 30 Sep 2024 17:27:30 +0200 Subject: [PATCH] Mark Couchbase and Kudu connectors as EOL (#3275) --- .github/workflows/link-validator.yml | 2 +- CONTRIBUTING.md | 8 -------- README.md | 4 ++-- build.sbt | 3 +-- docs/release-train-issue-template.md | 1 - docs/src/main/paradox/couchbase.md | 6 ++++++ docs/src/main/paradox/external/db2-event-store.md | 9 --------- docs/src/main/paradox/index.md | 1 - docs/src/main/paradox/kudu.md | 6 ++++++ docs/src/main/paradox/pravega.md | 5 ----- project/project-info.conf | 12 +++++++++++- scripts/link-validator.conf | 4 +++- 12 files changed, 30 insertions(+), 31 deletions(-) delete mode 100644 docs/src/main/paradox/external/db2-event-store.md diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml index 391401dae4..013ee1451d 100644 --- a/.github/workflows/link-validator.yml +++ b/.github/workflows/link-validator.yml @@ -37,4 +37,4 @@ jobs: run: sbt docs/makeSite - name: Run Link Validator - run: cs launch net.runne::site-link-validator:0.2.4 -- scripts/link-validator.conf + run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator.conf diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28c0eb2e59..b87d0b74c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,6 @@ We follow the standard GitHub [fork & pull](https://help.github.com/articles/usi You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc, or the README.md). The goal of these notes is to make your experience contributing to Alpakka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR. -# The Akka Community - -In case of questions about the contribution process or for discussion of specific issues please visit the [akka/dev gitter chat](https://gitter.im/akka/dev). - -You may also check out these [other resources](https://akka.io/get-involved/). - # Contributing to Alpakka ## Development Setup @@ -44,8 +38,6 @@ This is the process for committing code into main. 1. If the branch merge conflicts with its target, rebase your branch onto the target branch. -In case of questions about the contribution process or for discussion of specific issues please visit the [akka/dev gitter chat](https://gitter.im/akka/dev). - ## Alpakka specific advice diff --git a/README.md b/README.md index 698dce9850..6259398d9f 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ If you find an issue that you'd like to see fixed, the quickest way to make that Refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details about the workflow, and general hints on how to prepare your pull request. If you're planning to implement a new module within Alpakka, look at our [contributor advice](contributor-advice.md). -You can also ask for clarifications or guidance in GitHub issues directly, or in the [akka/dev](https://gitter.im/akka/dev) chat if a more real time communication would be of benefit. +You can also ask for clarifications or guidance in GitHub issues directly. Caveat Emptor ------------- @@ -58,4 +58,4 @@ License ------- Alpakka is licensed under the [Business Source License (BSL) 1.1](https://github.com/akka/alpakka/blob/main/LICENSE), please see the [Akka License FAQ](https://www.lightbend.com/akka/license-faq). -Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details. \ No newline at end of file +Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details. diff --git a/build.sbt b/build.sbt index 1f85a5a850..fc9141854c 100644 --- a/build.sbt +++ b/build.sbt @@ -417,7 +417,7 @@ lazy val docs = project "extref.geode.base_url" -> s"https://geode.apache.org/docs/guide/${Dependencies.GeodeVersionForDocs}/%s", "extref.javaee-api.base_url" -> "https://docs.oracle.com/javaee/7/api/index.html?%s.html", "extref.paho-api.base_url" -> "https://www.eclipse.org/paho/files/javadoc/index.html?%s.html", - "extref.pravega.base_url" -> s"https://cncf.pravega.io/docs/${Dependencies.PravegaVersionForDocs}/%s", + "extref.pravega.base_url" -> s"https://cncf.pravega.io/docs/latest/%s", "extref.slick.base_url" -> s"https://scala-slick.org/doc/${Dependencies.SlickVersion}/%s", // Cassandra "extref.cassandra.base_url" -> s"https://cassandra.apache.org/doc/${Dependencies.CassandraVersionInDocs}/%s", @@ -434,7 +434,6 @@ lazy val docs = project "javadoc.jakarta.jms.base_url" -> "https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/", "javadoc.jakarta.jms.link_style" -> "direct", "javadoc.com.couchbase.base_url" -> s"https://docs.couchbase.com/sdk-api/couchbase-java-client-${Dependencies.CouchbaseVersion}/", - "javadoc.io.pravega.base_url" -> s"http://pravega.io/docs/${Dependencies.PravegaVersionForDocs}/javadoc/clients/", "javadoc.org.apache.kudu.base_url" -> s"https://kudu.apache.org/releases/${Dependencies.KuduVersion}/apidocs/", "javadoc.org.apache.hadoop.base_url" -> s"https://hadoop.apache.org/docs/r${Dependencies.HadoopVersion}/api/", "javadoc.software.amazon.awssdk.base_url" -> "https://sdk.amazonaws.com/java/api/latest/", diff --git a/docs/release-train-issue-template.md b/docs/release-train-issue-template.md index d31d2450ed..989e662ca4 100644 --- a/docs/release-train-issue-template.md +++ b/docs/release-train-issue-template.md @@ -51,7 +51,6 @@ For important patch releases, and only if critical issues have been fixed: - [ ] Send a release notification to [Lightbend discuss](https://discuss.akka.io) - [ ] Tweet using the [@akkateam](https://twitter.com/akkateam/) account (or ask someone to) about the new release -- [ ] Announce on [Gitter akka/akka](https://gitter.im/akka/akka) - [ ] Announce internally (with links to Tweet, discuss) For minor or major releases: diff --git a/docs/src/main/paradox/couchbase.md b/docs/src/main/paradox/couchbase.md index 8f12aafbd4..622a1ac86b 100644 --- a/docs/src/main/paradox/couchbase.md +++ b/docs/src/main/paradox/couchbase.md @@ -1,5 +1,11 @@ # Couchbase +@@@ warning { title="End of life" } + +The Couchbase connector has not been updated for too long and is now considered End of Life. It will be removed with the next release of Alpakka. + +@@@ + @@@ note { title="Couchbase"} Couchbase is an open-source, distributed (shared-nothing architecture) multi-model NoSQL document-oriented database software package that is optimized for interactive applications. These applications may serve many concurrent users by creating, storing, retrieving, aggregating, manipulating and presenting data. In support of these kinds of application needs, Couchbase Server is designed to provide easy-to-scale key-value or JSON document access with low latency and high sustained throughput. It is designed to be clustered from a single machine to very large-scale deployments spanning many machines. diff --git a/docs/src/main/paradox/external/db2-event-store.md b/docs/src/main/paradox/external/db2-event-store.md deleted file mode 100644 index a304728a50..0000000000 --- a/docs/src/main/paradox/external/db2-event-store.md +++ /dev/null @@ -1,9 +0,0 @@ -# IBM Db2 Event Store - -This adapter provides an Akka Streams interface for [IBM Db2 Event Store](https://www.ibm.com/support/knowledgecenter/en/SSGNPV_1.1.2/eos?origURL=SSGNPV_1.1.2/eventstore/welcome.html). - - -## External library - -This library is not maintained in the Alpakka repository. -Learn more about it in the [sample application with Db2 EventStore](https://github.com/IBM/db2-event-store-akka-streams). diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md index 16ef1f709b..e584391618 100644 --- a/docs/src/main/paradox/index.md +++ b/docs/src/main/paradox/index.md @@ -43,7 +43,6 @@ The [Alpakka project](https://doc.akka.io/docs/alpakka/current/) is an initiativ * [Huawei Push Kit](huawei-push-kit.md) * [HTTP](external/http.md) * [IBM Bluemix Cloud Object storage](bluemix-cos.md) -* [IBM DB2 Event Store](external/db2-event-store.md) * [InfluxDB](influxdb.md) * [IronMQ](ironmq.md) * [Jakarta Messaging](jakarta-jms/index.md) diff --git a/docs/src/main/paradox/kudu.md b/docs/src/main/paradox/kudu.md index 3e62b13871..c4e2a175cc 100644 --- a/docs/src/main/paradox/kudu.md +++ b/docs/src/main/paradox/kudu.md @@ -1,5 +1,11 @@ # Apache Kudu +@@@warning { title="End of life" } + +The Kudu connector has not been updated for too long and is now considered End of Life. It will be removed with the next release of Alpakka. + +@@@ + The Alpakka Kudu connector supports writing to [Apache Kudu](https://kudu.apache.org) tables. Apache Kudu is a free and open source column-oriented data store in the Apache Hadoop ecosystem. diff --git a/docs/src/main/paradox/pravega.md b/docs/src/main/paradox/pravega.md index 0f967a7628..386e89e45a 100644 --- a/docs/src/main/paradox/pravega.md +++ b/docs/src/main/paradox/pravega.md @@ -187,8 +187,3 @@ Or a Flow Scala : @@snip[snip](/pravega/src/test/scala/akka/stream/alpakka/pravega/PravegaStreamAndTableSpec.scala) { #table-reading-flow } - - -## Support - -In addition to our regular Alpakka community support on [![gitter: akka/akka](https://img.shields.io/badge/gitter%3A-akka%2Fakka-blue.svg?style=flat-square)](https://gitter.im/akka/akka) and Lightbend's [discuss.lightbend.com](https://discuss.lightbend.com/c/akka/streams-and-alpakka). diff --git a/project/project-info.conf b/project/project-info.conf index ba9f93499e..a4679096a3 100644 --- a/project/project-info.conf +++ b/project/project-info.conf @@ -61,7 +61,7 @@ project-info { ] } aws-event-bridge: ${project-info.shared-info} { - title: "Alpakka AWS EventBriged" + title: "Alpakka AWS EventBridge" jpms-name: "akka.stream.alpakka.aws.eventbrigde" issues.url: ${project-info.labels}"aws-eventbrigde" levels: [ @@ -147,6 +147,11 @@ project-info { jpms-name: "akka.stream.alpakka.couchbase" issues.url: ${project-info.labels}"couchbase" levels: [ + { + readiness: EndOfLife + since: "2024-10-14" + since-version: "9.0.0-M1" + } { readiness: CommunityDriven since: "2022-04-04" @@ -583,6 +588,11 @@ project-info { jpms-name: "akka.stream.alpakka.kudu" issues.url: ${project-info.labels}"kudu" levels: [ + { + readiness: EndOfLife + since: "2024-10-14" + since-version: "9.0.0-M1" + } { readiness: CommunityDriven since: "2018-05-09" diff --git a/scripts/link-validator.conf b/scripts/link-validator.conf index c9eb35163c..40de090ae7 100644 --- a/scripts/link-validator.conf +++ b/scripts/link-validator.conf @@ -33,7 +33,9 @@ site-link-validator { # Datastax seem to be blocking bot requests "https://docs.datastax.com/en/developer/java-driver/", "https://docs.datastax.com/en/drivers/java/4.17/", - "https://docs.datastax.com/en/dse/6.7/" + "https://docs.datastax.com/en/dse/6.7/", + # PKIX path validation failed + "https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/" ] ignore-files = []