Documentation for 2.0 #264
Description
This is an umbrella issue to cover all the things we need regarding documentation for 2.0:
- Examples: Add examples #125
- Enable javadoc failures when running
mvn verify(mvn javadoc plugin) Build javadoc in all profiles #275 - Check missing javadoc, missing javadoc tags and internal and external links are working properly
- api Javadoc'ed + Cleanup of the api module #267
- core Javadocs api and core #313
- formats/json-jackson Jackson javadocs #319
- http/basic Http modules javadocs #320
- http/restful-ws Http modules javadocs #320
- http/vertx Http modules javadocs #320
- kafka Kafka javadocs #321
- amqp AMQP javadocs #322
- spring Spring Javadocs #323
- Update website:
- Check website technical details (jekyll version, theme version, ...)
- Develop a page that shows the basic features to operate with CloudEvents: CloudEvent, CloudEventBuilder, how to interact with
CloudEventDataand map it to pojos, ... Website docs #324 - Develop a page that shows the basics of using
EventFormat, showing an example for json (using jackson) Website docs #324 - Move readmes of separate modules to website pages, one page per module (and point modules back to website pages) Website docs #324
- core and api (they might require a single page for both) Website docs #324
- formats/json-jackson Website docs #324
- http/basic Website docs #324
- http/restful-ws Website docs #324
- http/vertx Website docs #324
- kafka Website docs #324
- Develop a page that explains some advanced stuff, like how to create your own
CloudEvent, how to create a protocol binding, how to create your own event format, etc
If you're going to work in one of the issues described above, please write it down in the comments.