From 397fc9d79c59245b92eeed92bd8876658c8931e0 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Tue, 20 Feb 2024 12:22:23 -0600 Subject: [PATCH] [Docs] Rewmove project-state.adoc (not needed) --- README.adoc | 2 -- .../src/main/antora/modules/ROOT/nav.adoc | 1 - .../ROOT/pages/intro/project-state.adoc | 34 ------------------- 3 files changed, 37 deletions(-) delete mode 100644 spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc diff --git a/README.adoc b/README.adoc index 3e75d967..1ebeb78a 100644 --- a/README.adoc +++ b/README.adoc @@ -6,8 +6,6 @@ Spring for Apache Pulsar provides a basic Spring-friendly API for developing htt **#TIP#**: Most of the ideas in this project are borrowed from the Spring for Apache Kafka project, thus a familiarity with it would help. -include::spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc[leveloffset=+1] - == Getting Started The {docs}[reference documentation] includes a {docs}/reference/pulsar.html#quick-tour[quick tour] section. diff --git a/spring-pulsar-docs/src/main/antora/modules/ROOT/nav.adoc b/spring-pulsar-docs/src/main/antora/modules/ROOT/nav.adoc index ea2882ed..803e0467 100644 --- a/spring-pulsar-docs/src/main/antora/modules/ROOT/nav.adoc +++ b/spring-pulsar-docs/src/main/antora/modules/ROOT/nav.adoc @@ -1,7 +1,6 @@ * xref:index.adoc[Overview] * xref:whats-new.adoc[] * xref:intro.adoc[] -** xref:intro/project-state.adoc[] ** xref:intro/system-requirements.adoc[] ** xref:intro/building.adoc[] ** xref:intro/getting-help.adoc[] diff --git a/spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc b/spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc deleted file mode 100644 index c6d8d117..00000000 --- a/spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc +++ /dev/null @@ -1,34 +0,0 @@ -[[project-status]] -= Project Status - -While the code and functionality of the framework is thoroughly tested and ready for production, the project is in a bit of flux while transitioning from experimental GA (`0.2.x`) to GA (`1.0.0`). - -The evolution of the project (by version) is as follows: - -[discrete] -== Version 0.2.x -All components (`the core + Spring Boot autoconfiguration + Spring Cloud Stream binder`) reside in the `spring-pulsar` Github repository. - -This is considered an "experimental" GA, defined as: - -- code and functionality is production ready, but decision has not been made to support the project permanently -- available on Maven Central using a major version of `0` to indicate its nature - -NOTE: Until the GA release, the recommended version of the framework is `0.2.x`. - -[discrete] -== Version 1.0.x -This is the "full" GA and the components are split as follows (in-progress): - -- the core stays in the `spring-pulsar` repo (`main` branch) -- the autoconfiguration moves to the Spring Boot project (targeting Spring Boot `3.2.0`) -- the binder moves to the Spring Cloud Stream project (targeting SCSt `4.1.0`) - -[CAUTION] -==== -Be aware that as the autoconfiguration moves to the Spring Boot project the dependency coordinates for the starter modules also change as follows: - -* The group id goes from `org.springframework.pulsar` to `org.springframework.boot` -* The artifact id goes from `spring-pulsar-spring-boot-starter` to `spring-boot-starter-pulsar` (same pattern for the reactive starter) -* The version goes from `0.2.x` to `3.2.x` -====