Updated Release_notes.md for 2.1.0 release
#80
Conversation
dmccoystephenson
requested review from
payneBrandon,
drewjj,
Michael7371 and
mwodahl
docs/Release_notes.md
Outdated
| Version 2.1.0, released June 2024 | ||
| ---------------------------------------- | ||
| ### **Summary** | ||
| The updates for the jpo-ode 2.1.0 release include several key improvements and fixes. These updates address issues with PSM and log offloading, and enhance the continuous integration processes. The Kafka version has been upgraded, and a bug related to log processing has been resolved. Nanoseconds are now trimmed from timestamps, and 1609.2 headers are now stripped from unsigned messages. A submodule compatibility guide has been added, along with making the default SNMP protocol configurable. Configurable signing is now possible independently for Road Side Units (RSUs) and the SDX. The Dockerhub documentation now includes a link to the submodule compatibility guide. Maven plugin versions have been updated, and the Kafka topic creation process has been improved. A timestamp precision bug has been fixed, and the documentation has been revised for accuracy. Additionally, the NTCIP1218 msgRepeatOptions value is now set based on context, and SnmpSession now reports failures to retrieve authoritative engine IDs only if a response is received. Finally, the TimDeleteController has been updated to log message deletion failures as errors. |
There was a problem hiding this comment.
Not the biggest deal, but generally when you have a short sentence with an 'and' you generally don't need a comma before the 'and'. You have a lot of sentences here like "The Kafka version has been upgraded, and a bug related to log processing has been resolved" where the comma doesn't make a whole lot of sense. It might be how you would naturally pause if you said it out loud but the statement is perfectly fine without a comma.
There was a problem hiding this comment.
Thanks for highlighting this! I have adjusted the commas where 'and' is being used.
docs/Release_notes.md
Outdated
| Version 2.1.0, released June 2024 | ||
| ---------------------------------------- | ||
| ### **Summary** | ||
| The updates for the jpo-ode 2.1.0 release include several key improvements and fixes. These updates address issues with PSM and log offloading and enhance the continuous integration processes. The Kafka version has been upgraded and a bug related to log processing has been resolved. Nanoseconds are now trimmed from timestamps and 1609.2 headers are now stripped from unsigned messages. A submodule compatibility guide has been added, along with making the default SNMP protocol configurable. Configurable signing is now possible independently for Road Side Units (RSUs) and the SDX. The Dockerhub documentation now includes a link to the submodule compatibility guide. Maven plugin versions have been updated and the Kafka topic creation process has been improved. A timestamp precision bug has been fixed and the documentation has been revised for accuracy. Additionally, the NTCIP1218 msgRepeatOptions value is now set based on context and SnmpSession now reports failures to retrieve authoritative engine IDs only if a response is received. Finally, the TimDeleteController has been updated to log message deletion failures as errors. |
There was a problem hiding this comment.
Technically if you are going to spell out RSU, it would be "Roadside Unit". You could make it "Road-Side Unit" if you want to make it similar to OBU with "On-Board Unit"
There was a problem hiding this comment.
Changed to Road-Side Unit
docs/Release_notes.md
Outdated
| CDOT PR 67: Added configurable signing independently for RSUs and the SDX | ||
| CDOT PR 69: Added link to submodule compatibility guide to dockerhub documentation | ||
| CDOT PR 70: Updated maven plugin versions | ||
| CDOT PR 71: Updated kafka topic creation |
There was a problem hiding this comment.
Lets capitalize Kafka here since it is done elsewhere in these notes.
docs/Release_notes.md
Outdated
| CDOT PR 65: Added support for retaining IEEE 1609.2 security headers | ||
| CDOT PR 66: Made default SNMP protocol configurable | ||
| CDOT PR 67: Added configurable signing independently for RSUs and the SDX | ||
| CDOT PR 69: Added link to submodule compatibility guide to dockerhub documentation |
There was a problem hiding this comment.
I believe it is referred to as "Docker Hub" instead of all one word. This is based off my google results. Not confident here.
There was a problem hiding this comment.
Changed to Docker Hub
PR Details
Description
The release notes for the 2.1.0 release have been added to
Release_notes.md.Related Issue
No related GitHub issue.
Motivation and Context
A new version of the ODE will be released next month, and getting the release notes drafted is a prerequisite for this.
How Has This Been Tested?
Documentation change, no testing necessary.
Types of changes
Checklist:
ODE Contributing Guide
Dependent PR
Some of the changes mentioned are still in PR review. This PR can be merged after #74 and #78.