Documentation Updates & Removal of TIM Support #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ssage types to README
Sync develop with latest USDOT changes
…docs-for-accuracy
Added 'Supported Message Types' section to README
…b.com/CDOT-CV/jpo-cvdp into refactoring/remove-tim-references
Removed TIM Support
Revised Documentation for Accuracy
Release Notes (2024 Q3 Release)
dan-du-car
reviewed
Sep 20, 2024
| @@ -103,7 +115,7 @@ Example configuration files can be found in the [jpo-cvdp/config](../config) dir | |||
|
|
|||
| The details of the settings and how they affect the function of the PPM follow: | |||
|
|
|||
| ## Sanitization Flag | |||
| ### Sanitization Flag | |||
There was a problem hiding this comment.
Do we want to remove the TIM related doc here?
There was a problem hiding this comment.
This has been removed!
| 1. Pull the project into VSCode | ||
| 1. Reopen the project in a dev container | ||
| 1. Open the terminal. | ||
| 1. Type "sudo su" to run commands as root |
There was a problem hiding this comment.
It seems the permission needs some work.
There was a problem hiding this comment.
The dev container configuration has been modified to make all shell scripts executable upon starting.
…m-docker-compose-files Removed unnecessary 'version' element from docker-compose files
…iguration Added standalone configuration instructions to testing documentation
…e-in-dev-container Modified dev container to make all scripts executable upon creation
…nfiguration-doc Removed TIM reference from configuration documentation
dan-du-car
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README Update: Supported Message Types
Problem
The README mentions basic safety messages (BSMs) but lacks a clear list of supported message types. This can lead users to mistakenly attempt processing unsupported message types.
Solution
A new 'Supported Message Types' section has been added to the README, clarifying that only BSMs are currently supported.
Removal of TIM Support
Problem
Although the PPM currently supports processing TIMs, this isn't part of the data flow to RSUs and the SDX. TIMs are only filtered based on geofences and do not contain personally identifiable information. Therefore, TIM support is unnecessary.
Solution
All references to TIMs have been removed from the project.
Testing
do_kafka_test.shscript has been verified to work with these changes.Documentation Update
Problem
The documentation was outdated.
Solution
The documentation has been reviewed & revised for accuracy.