Skip to content

Commit 58a6426

Browse files
Reorganized some readmes/docs (#193)
* Added javadocs links both to READMEs and docs Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Removed old docs of v1 of the sdk Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
1 parent d4ee5a6 commit 58a6426

File tree

9 files changed

+23
-236
lines changed

9 files changed

+23
-236
lines changed

CHANGELOG.md

Lines changed: 0 additions & 100 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,18 @@ Supported features of the specification:
4040

4141
The [CloudEvents specification](https://github.com/cloudevents/spec) is a vendor-neutral specification for defining the format of event data that is being exchanged between different cloud systems. The specification basically defines an abstract envelope for any event data payload, without knowing specific implementation details of the actual underlying event. The current version of the spec is at `0.3` and it describes a simple event format, which was demonstrated at [KubeCon 2018](https://youtu.be/TZPPjAv12KU) using different _Serverless platforms_, such as [Apache Openwhisk](https://github.com/apache/incubator-openwhisk).
4242

43-
## Java API
43+
## Documentation
4444

45-
For Maven based projects, use the following to configure the CloudEvents Java SDK:
45+
Documentation is available at https://cloudevents.github.io/sdk-java/
4646

47-
```xml
48-
<dependency>
49-
<groupId>io.cloudevents</groupId>
50-
<artifactId>cloudevents-core</artifactId>
51-
<version>2.0.0-milestone1</version>
52-
</dependency>
53-
```
47+
Javadocs are available on [javadoc.io](https://www.javadoc.io):
48+
49+
* [cloudevents-api](https://www.javadoc.io/doc/io.cloudevents/cloudevents-api)
50+
* [cloudevents-core](https://www.javadoc.io/doc/io.cloudevents/cloudevents-core)
51+
* [cloudevents-json-jackson](https://www.javadoc.io/doc/io.cloudevents/cloudevents-json-jackson)
52+
* [cloudevents-http-restful-ws](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws)
53+
* [cloudevents-http-vertx](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-vertx)
54+
* [cloudevents-kafka](https://www.javadoc.io/doc/io.cloudevents/cloudevents-kafka)
5455

5556
## Community
5657

@@ -63,4 +64,4 @@ For Maven based projects, use the following to configure the CloudEvents Java SD
6364
- Slack: #cloudeventssdk channel under
6465
[CNCF's Slack workspace](https://slack.cncf.io/).
6566
- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
66-
- Contact for additional information: Fabio José (`@fabiojose` on slack).
67+
- Contact for additional information: Francesco Guardiani (`@slinkydeveloper` on slack), Fabio José (`@fabiojose` on slack).

README_v1.md

Lines changed: 0 additions & 126 deletions
This file was deleted.

api/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# CloudEvents API
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-api.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-api)
4+
35
For Maven based projects, use the following dependency:
46

57
```xml

core/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# CloudEvents Core
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-core.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-core)
4+
35
The base classes, interfaces and low-level APIs to use CloudEvents.
46

57
## How to Use

formats/json-jackson/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Json EventFormat implementation with Jackson
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-json-jackson.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-json-jackson)
4+
35
Implementation of [`EventFormat`](../../api/src/main/java/io/cloudevents/format/EventFormat.java) using Jackson.
46

57
For Maven:

http/restful-ws/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# HTTP Protocol Binding for Jakarta RESTful Web Services
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-http-restful-ws.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws)
4+
35
For Maven based projects, use the following to configure the CloudEvents Jakarta RESTful Web Services Binding:
46

57
```xml

http/vertx/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# HTTP Protocol Binding for Eclipse Vert.x
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-http-vertx.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-http-vertx)
4+
35
For Maven based projects, use the following to configure the CloudEvents Vertx HTTP Transport:
46

57
```xml

kafka/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Kafka Protocol Binding
22

3+
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-kafka.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-kafka)
4+
35
For Maven based projects, use the following to configure the [Kafka Protocol Binding](https://github.com/cloudevents/spec/blob/master/kafka-protocol-binding.md):
46

57
```xml

0 commit comments

Comments
 (0)