From e460b94b90ea93658a9bedb1af2509ea71cacae4 Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Mon, 7 Jan 2019 15:50:15 -0500 Subject: [PATCH] Moves Maintenance Mode section to file and includes it in readme --- README.adoc | 24 +++++++++++++++++++ docs/src/main/asciidoc/README.adoc | 2 ++ docs/src/main/asciidoc/maintenance-mode.adoc | 23 ++++++++++++++++++ .../main/asciidoc/spring-cloud-netflix.adoc | 23 +----------------- 4 files changed, 50 insertions(+), 22 deletions(-) create mode 100644 docs/src/main/asciidoc/maintenance-mode.adoc diff --git a/README.adoc b/README.adoc index 7b7075c27..61e07d0dd 100644 --- a/README.adoc +++ b/README.adoc @@ -23,6 +23,30 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon). * External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions) * Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation + +== Modules In Maintenance Mode + +Placing a module in maintenance mode means that the Spring Cloud team will no longer be adding new features to the module. +We will fix blocker bugs and security issues, and we will also consider and review small pull requests from the community. + +We intend to continue to support these modules for a period of at least a year from the general availability +of the Greenwich release train. + +The following Spring Cloud Netflix modules and corresponding starters will be placed into maintenance mode: + +* spring-cloud-netflix-archaius +* spring-cloud-netflix-hystrix-contract +* spring-cloud-netflix-hystrix-dashboard +* spring-cloud-netflix-hystrix-stream +* spring-cloud-netflix-hystrix +* spring-cloud-netflix-ribbon +* spring-cloud-netflix-turbine-stream +* spring-cloud-netflix-turbine +* spring-cloud-netflix-zuul + +NOTE: This does not include the Eureka or concurrency-limits modules. + + == Building :jdkversion: 1.8 diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index efca2c467..92e6fd166 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -15,6 +15,8 @@ include::intro.adoc[] * External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions) * Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation +include::maintenance-mode.adoc[] + == Building include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-jdk8.adoc[] diff --git a/docs/src/main/asciidoc/maintenance-mode.adoc b/docs/src/main/asciidoc/maintenance-mode.adoc new file mode 100644 index 000000000..fd5c8907a --- /dev/null +++ b/docs/src/main/asciidoc/maintenance-mode.adoc @@ -0,0 +1,23 @@ + +== Modules In Maintenance Mode + +Placing a module in maintenance mode means that the Spring Cloud team will no longer be adding new features to the module. +We will fix blocker bugs and security issues, and we will also consider and review small pull requests from the community. + +We intend to continue to support these modules for a period of at least a year from the general availability +of the Greenwich release train. + +The following Spring Cloud Netflix modules and corresponding starters will be placed into maintenance mode: + +* spring-cloud-netflix-archaius +* spring-cloud-netflix-hystrix-contract +* spring-cloud-netflix-hystrix-dashboard +* spring-cloud-netflix-hystrix-stream +* spring-cloud-netflix-hystrix +* spring-cloud-netflix-ribbon +* spring-cloud-netflix-turbine-stream +* spring-cloud-netflix-turbine +* spring-cloud-netflix-zuul + +NOTE: This does not include the Eureka or concurrency-limits modules. + diff --git a/docs/src/main/asciidoc/spring-cloud-netflix.adoc b/docs/src/main/asciidoc/spring-cloud-netflix.adoc index 3c416e7b7..cac4aa32e 100755 --- a/docs/src/main/asciidoc/spring-cloud-netflix.adoc +++ b/docs/src/main/asciidoc/spring-cloud-netflix.adoc @@ -2162,26 +2162,5 @@ NOTE: When you create your own HTTP client, you are also responsible for impleme Doing so improperly can result in resource management issues. // TODO Can we provide a link to how to do so? -== Modules In Maintenance Mode - -Placing a module in maintenance mode means that the Spring Cloud team will no longer be adding new features to the module. -We will fix blocker bugs and security issues, and we will also consider and review small pull requests from the community. - -We intend to continue to support these modules for a period of at least a year from the general availability -of the Greenwich release train. - -The following Spring Cloud Netflix modules and corresponding starters will be placed into maintenance mode: - -* spring-cloud-netflix-archaius -* spring-cloud-netflix-hystrix-contract -* spring-cloud-netflix-hystrix-dashboard -* spring-cloud-netflix-hystrix-stream -* spring-cloud-netflix-hystrix -* spring-cloud-netflix-ribbon -* spring-cloud-netflix-turbine-stream -* spring-cloud-netflix-turbine -* spring-cloud-netflix-zuul - -NOTE: This does not include the Eureka or concurrency-limits modules. - +include::maintenance-mode.adoc[]