Skip to content

Commit

Permalink
Prepare documantation for the new release/c4.1 branch (#229)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tommystendahl
tommystendahl authored Oct 3, 2023
1 parent 5469db8 commit 3f80f89
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 12 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,17 @@ At the moment the oldest maintained release branch is ```release/c3.0```
which is tracking the latest release of Cassandra 3.0.x.
Then comes ```release/3.11```
which is tracking the latest release of Cassandra 3.11.x.
The ```master``` branch is tracking the latest release of Cassandra 4.0.x.
Then comes ```release/4.0```
which is tracking the latest release of Cassandra 4.0.x.
Then comes ```release/4.1```
which is tracking the latest release of Cassandra 4.1.x.
The ```master``` branch is tracking the latest release of Cassandra 5.0.x.

Pull Requests with new features should typically target ```release/c3.11```.
Merge order is then ```PR``` -> ```release/c3.11``` -> ```master```
Merge order is then ```PR``` -> ```release/c3.11``` -> ```release/c4.0``` -> ```release/c4.1``` -> ```master```

Pull Requests with critical fixes should typically target ```release/c3.0```.
Merge order is then ```PR``` -> ```release/c3.0``` -> ```release/c3.11``` -> ```master```
Merge order is then ```PR``` -> ```release/c3.0``` -> ```release/c3.11``` -> ```release/c4.0``` -> ```release/c4.1``` -> ```master```

It is encouraged to encapsulate differences between flavors in Flavor Adapters.
This simplifies maintenance and merging between flavors.
Expand Down
10 changes: 7 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ ecAudit integrates with Apache Cassandra using its existing plug-in points.
Official releases of ecAudit can be downloaded from Maven Central.
Get the ecAudit flavor for your Cassandra version.

[![ecAudit for Cassandra 5.0.<latest>](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c5.0.svg?label=ecAudit%20for%20Cassandra%205.0.<latest>)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c5.0%22)
[![ecAudit for Cassandra 4.1.<latest>](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c4.1.svg?label=ecAudit%20for%20Cassandra%204.1.<latest>)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c4.1%22)
[![ecAudit for Cassandra 4.0.<latest>](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c4.0.svg?label=ecAudit%20for%20Cassandra%204.0.<latest>)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c4.0%22)
[![ecAudit for Cassandra 3.11.<latest>](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c3.11.svg?label=ecAudit%20for%20Cassandra%203.11.<latest>)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c3.11%22)
Expand All @@ -61,7 +62,8 @@ The following flavors of ecAudit are no longer maintained.

Install and configure ecAudit using the setup guide for your Cassandra version.

* [ecAudit Setup Guide for Cassandra 4.1.\<latest>](https://github.com/Ericsson/ecaudit/blob/master/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 5.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/master/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 4.1.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c4.1/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 4.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c4.0/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 3.11.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c3.11/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 3.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c3.0/doc/setup.md)
Expand All @@ -71,7 +73,8 @@ Install and configure ecAudit using the setup guide for your Cassandra version.

Upgrade ecAudit using then upgrade guide for your Cassandra version

* [ecAudit Upgrade Guide for Cassandra 4.1.\<latest>](https://github.com/Ericsson/ecaudit/blob/master/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 5.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/master/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 4.1.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c4.1/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 4.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c4.0/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 3.11.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c3.11/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 3.0.\<latest>](https://github.com/Ericsson/ecaudit/blob/release/c3.0/UPGRADING.md)
Expand All @@ -96,11 +99,12 @@ The following developers have contributed to the ecAudit project:
* Marcus Olsson
* Ted Petersson
* Pushpendra Rajpoot
* Tommy Stendahl


## License

Copyright 2018-22 Telefonaktiebolaget LM Ericsson
Copyright 2018-23 Telefonaktiebolaget LM Ericsson

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
22 changes: 16 additions & 6 deletions doc/cassandra_compatibility.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,25 @@ For instance, ecaudit_c3.11 indicate that the ecAudit flavor was built with Cass
The ecAudit plug-in is maintained for selected Cassandra versions only.


## ecaudit_c4.1

This flavor is built with the latest version of the Apache Cassandra 4.1.x series.
The table below list the Cassandra version used while building each ecAudit release and indicate compatibility with other Cassandra versions.

| ecAudit Version | Compiled With | Compatible With |
| ---------------- | --------------- | ------------------------ |
| 3.0.0 -> latest | Cassandra 4.1.2 | Cassandra 4.1.0 -> 4.1.3 |


## ecaudit_c4.0

This flavor is built with the latest version of the Apache Cassandra 4.0.x series.
The table below list the Cassandra version used while building each ecAudit release and indicate compatibility with other Cassandra versions.

| ecAudit Version | Compiled With | Compatible With |
| ---------------- | --------------- | ------------------------ |
| 2.10.0 -> latest | Cassandra 4.0.7 | Cassandra 4.0.2 -> 4.0.8 |
| 2.9.0 -> latest | Cassandra 4.0.3 | Cassandra 4.0.2 -> 4.0.8 |
| ecAudit Version | Compiled With | Compatible With |
| ---------------- | --------------- | ------------------------- |
| 2.10.0 -> latest | Cassandra 4.0.7 | Cassandra 4.0.2 -> 4.0.11 |
| 2.9.0 -> latest | Cassandra 4.0.3 | Cassandra 4.0.2 -> 4.0.8 |


## ecaudit_c3.11
Expand All @@ -25,7 +35,7 @@ The table below list the Cassandra version used while building each ecAudit rele

| ecAudit Version | Compiled With | Compatible With |
| ---------------- | ----------------- | ---------------------------- |
| 2.10.0 -> latest | Cassandra 3.11.14 | Cassandra 3.11.12 -> 3.11.14 |
| 2.10.0 -> latest | Cassandra 3.11.14 | Cassandra 3.11.12 -> 3.11.16 |
| 2.9.1 | Cassandra 3.11.12 | Cassandra 3.11.12 -> 3.11.14 |
| 2.9.0 | Cassandra 3.11.12 | Cassandra 3.11.11 -> 3.11.14 |
| 2.8.0 | Cassandra 3.11.11 | Cassandra 3.11.2 -> 3.11.11 |
Expand All @@ -42,7 +52,7 @@ The table below list the Cassandra version used while building each ecAudit rele

| ecAudit Version | Compiled With | Compatible With |
| ---------------- | ---------------- | -------------------------- |
| 2.10.0 -> latest | Cassandra 3.0.28 | Cassandra 3.0.25 -> 3.0.28 |
| 2.10.0 -> latest | Cassandra 3.0.28 | Cassandra 3.0.25 -> 3.0.29 |
| 2.9.0 | Cassandra 3.0.26 | Cassandra 3.0.25 -> 3.0.27 |
| 2.8.0 | Cassandra 3.0.25 | Cassandra 3.0.16 -> 3.0.25 |
| 2.7.0 -> 2.7.1 | Cassandra 3.0.24 | Cassandra 3.0.16 -> 3.0.24 |
Expand Down

0 comments on commit 3f80f89

Please sign in to comment.