diff --git a/README.md b/README.md index d36568450..778fa540c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Spring Batch [![build status](https://build.spring.io/plugins/servlet/wittified/build-status/BATCH-GRAD)](https://build.spring.io/browse/BATCH-GRAD) -Spring Batch is a lightweight, comprehensive batch framework designed to enable the development of robust batch applications vital for the daily operations of enterprise systems. Spring Batch builds upon the productivity, POJO-based development approach, and general ease of use capabilities people have come to know from the [Spring Framework](https://github.com/SpringSource/spring-framework), while making it easy for developers to access and leverage more advanced enterprise services when necessary. +Spring Batch is a lightweight, comprehensive batch framework designed to enable the development of robust batch applications vital for the daily operations of enterprise systems. Spring Batch builds upon the productivity, POJO-based development approach, and general ease of use capabilities people have come to know from the [Spring Framework](https://github.com/spring-projects/spring-framework), while making it easy for developers to access and leverage more advanced enterprise services when necessary. If you are looking for a runtime orchestration tool for your Batch applications, or need a management console to view current and historic executions, take a look at [Spring Cloud Data Flow](https://cloud.spring.io/spring-cloud-dataflow/). It is an orchestration tool for deploying and executing data integration based microservices including Spring Batch applications. @@ -36,13 +36,16 @@ It requires an internet connection for download, and access to a Maven repositor # Getting Help -Read the main project [website](https://projects.spring.io/spring-batch/) and the [User Guide](https://docs.spring.io/spring-batch/trunk/reference/). Look at the source code and the Javadocs. For more detailed questions, use the [forum](https://forum.spring.io/forum/spring-projects/batch). If you are new to Spring as well as to Spring Batch, look for information about [Spring projects](https://spring.io/projects). +Read the main project [website](https://projects.spring.io/spring-batch/) and the [User Guide](https://docs.spring.io/spring-batch/docs/current/reference/). +Look at the source code and the Javadocs. +For more detailed questions, use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch). +If you are new to Spring as well as to Spring Batch, look for information about [Spring projects](https://spring.io/projects). # Contributing to Spring Batch Here are some ways for you to get involved in the community: -* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](https://forum.spring.io/forum/spring-projects/batch) by responding to questions and joining the debate. +* Get involved with the Spring community on the Spring Community Forums. Please help out on the [gitter channel](https://gitter.im/spring-batch/Lobby) by responding to questions and joining the debate. * Create [JIRA](https://jira.spring.io/browse/BATCH) tickets for bugs and new features and comment and vote on the ones that you are interested in. * Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, please familiarize yourself with the process outlined for contributing to Spring projects here: [Contributor Guidelines](https://github.com/spring-projects/spring-batch/blob/master/CONTRIBUTING.md). * Watch for upcoming articles on Spring by [subscribing](feed://assets.spring.io/drupal/node/feed.xml) to spring.io @@ -51,4 +54,3 @@ Before we accept a non-trivial patch or pull request we will need you to sign th # Code of Conduct This project adheres to the [Contributor Covenant ](https://github.com/spring-projects/spring-batch/blob/master/CODE_OF_CONDUCT.adoc). By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. - \ No newline at end of file diff --git a/spring-batch-docs/asciidoc/header/index-header.adoc b/spring-batch-docs/asciidoc/header/index-header.adoc index 82a07ca31..ea5c0eb17 100644 --- a/spring-batch-docs/asciidoc/header/index-header.adoc +++ b/spring-batch-docs/asciidoc/header/index-header.adoc @@ -1,3 +1,3 @@ = Spring Batch - Reference Documentation -:batch-asciidoc: https://docs.spring.io/spring-batch/reference/html/ +:batch-asciidoc: https://docs.spring.io/spring-batch/docs/current/reference/html/ diff --git a/spring-batch-docs/asciidoc/job.adoc b/spring-batch-docs/asciidoc/job.adoc index 6f7c7260b..e35819e88 100644 --- a/spring-batch-docs/asciidoc/job.adoc +++ b/spring-batch-docs/asciidoc/job.adoc @@ -1612,7 +1612,7 @@ If you set the table prefix on the job repository, don't forget to set it on the Most of the methods on `JobOperator` are self-explanatory, and more detailed explanations can be found on the - link:$$https://docs.spring.io/spring-batch/apidocs/org/springframework/batch/core/launch/JobOperator.html$$[javadoc of the interface]. However, the + link:$$https://docs.spring.io/spring-batch/docs/current/api/org/springframework/batch/core/launch/JobOperator.html$$[javadoc of the interface]. However, the `startNextInstance` method is worth noting. This method will always start a new instance of a Job. This can be extremely useful if there are serious issues in a diff --git a/spring-batch-docs/asciidoc/spring-batch-integration.adoc b/spring-batch-docs/asciidoc/spring-batch-integration.adoc index 7513439de..ed64a7740 100644 --- a/spring-batch-docs/asciidoc/spring-batch-integration.adoc +++ b/spring-batch-docs/asciidoc/spring-batch-integration.adoc @@ -936,7 +936,7 @@ configured `SimpleChunkProcessor`, which is where you would provide a reference when it receives chunks from the manager. For more information, see the section of the "Scalability" chapter on -link:$$https://docs.spring.io/spring-batch/reference/html/scalability.html#remoteChunking$$[Remote Chunking]. +link:$$https://docs.spring.io/spring-batch/docs/current/reference/html/scalability.html#remoteChunking$$[Remote Chunking]. Starting from version 4.1, Spring Batch Integration introduces the `@EnableBatchIntegration` annotation that can be used to simplify a remote chunking setup. This annotation provides diff --git a/spring-batch-docs/asciidoc/testing.adoc b/spring-batch-docs/asciidoc/testing.adoc index e6f0950de..e355e184f 100644 --- a/spring-batch-docs/asciidoc/testing.adoc +++ b/spring-batch-docs/asciidoc/testing.adoc @@ -394,4 +394,4 @@ public void testAfterStep() { The preceding method for creating a simple `StepExecution` is just one convenience method available within the factory. A full method listing can be found in its - link:$$https://docs.spring.io/spring-batch/apidocs/org/springframework/batch/test/MetaDataInstanceFactory.html$$[Javadoc]. + link:$$https://docs.spring.io/spring-batch/docs/current/api/org/springframework/batch/test/MetaDataInstanceFactory.html$$[Javadoc]. diff --git a/spring-batch-docs/asciidoc/whatsnew.adoc b/spring-batch-docs/asciidoc/whatsnew.adoc index c0beda4a1..b155ed6e1 100644 --- a/spring-batch-docs/asciidoc/whatsnew.adoc +++ b/spring-batch-docs/asciidoc/whatsnew.adoc @@ -4,44 +4,6 @@ [[whatsNew]] -== What's New in Spring Batch 4.2 +== What's New in Spring Batch 4.3 -Spring Batch 4.2 adds the following features: - -* Support for batch metrics with https://micrometer.io[Micrometer] -* Support for reading/writing data from/to https://kafka.apache.org[Apache Kafka] topics -* Support for reading/writing data from/to https://avro.apache.org[Apache Avro] resources -* Improved documentation - -[[whatsNewMetrics]] -=== Batch metrics with Micrometer - -This release introduces a new feature that lets you monitor your batch jobs -by using Micrometer. By default, Spring Batch collects metrics (such as job duration, -step duration, item read and write throughput, and others) and registers them in Micrometer's -global metrics registry under the `spring.batch` prefix. -These metrics can be sent to any https://micrometer.io/docs/concepts#_supported_monitoring_systems[monitoring system] -supported by Micrometer. - -For more details about this feature, please refer to the -<> chapter. - -[[whatsNewKafka]] -=== Apache Kafka item reader/writer - -This release adds a new `KafkaItemReader` and `KafkaItemWriter` to read data from and -write it to Kafka topics. For more details about these new components, please refer -to the https://docs.spring.io/spring-batch/4.2.x/api/index.html[Javadoc]. - -[[whatsNewAvro]] -=== Apache Avro item reader/writer - -This release adds a new `AvroItemReader` and `AvroItemWriter` to read data from and -write it to Avro resources. For more details about these new components, please refer -to the https://docs.spring.io/spring-batch/4.2.x/api/index.html[Javadoc]. - -[[whatsNewDocs]] -=== Documentation updates - -The reference documentation has been updated to match the same style as other -Spring projects. +TDB diff --git a/src/api/overview.html b/src/api/overview.html index a14718f5f..ed343fc09 100644 --- a/src/api/overview.html +++ b/src/api/overview.html @@ -6,7 +6,7 @@

For further API reference and developer documentation, see the - Spring + Spring Batch reference documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms,