Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revised Documentation for Accuracy + Dev Container Java Update #39

Merged
merged 22 commits into from
Jun 11, 2024

Conversation

dmccoystephenson
Copy link
Contributor

Revised Documentation for Accuracy

Description

The documentation for the project has been reviewed and revised for accuracy. In some cases, improvements were made to formatting/organization to improve clarity.

Changes

  • Removed Travis & Sonar badges from the top of the README since they were not properly connected.
  • Corrected 'Situation Data Warehouse' to 'Situational Data Exchange' at top of README & added hyperlink
  • Adjusted headers to improve clarity. There should now only be one top-level header (#) in the README.
  • Reworded the 'Overview' section of the README and added a link to the SDX REST API documentation.
  • Corrected capitalization in 'Release Notes' section of README
  • Reorganized 'Installation & Operation' section to include four options.
  • Reworded & updated 'Configuration Reference' section
  • Moved 'Confluent Cloud Integration' section to bottom of README
  • Improved formatting of 'Object Data Consumption' section of README

Dev Container Java Update

Description

The dev container has been updated to use a Java 21 image, replacing the previous Java 17 image. This update enables the project to be compiled within the dev container.

Testing

All existing unit tests have been verified to pass with these changes.

mwodahl and others added 20 commits March 27, 2024 13:53
…entation

Revised Documentation for Accuracy
…NAPSHOT

Changed version to 1.7.0-SNAPSHOT
Release notes for jpo-sdw-depositor 1.7.0
Dockerfile Show resolved Hide resolved

Subscribes to a Kafka topic and deposits messages to the Situation Data Warehouse (SDW).
Subscribes to a Kafka topic and deposits messages to the [Situational Data Exchange (SDX)](https://sdx.trihydro.com/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I understand what is the difference between the SDW and SDX. Do we need to rename this jpo-sdw-depositor to jpo-sdx-depositor?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SDX used to be called the SDW, but has since been renamed. Ideally the repository would be renamed to jpo-sdx-depositor to match, yeah.

sample.env Show resolved Hide resolved
@dan-du-car
Copy link
Contributor

Looks good. I left some minor comments.

@dmccoystephenson
Copy link
Contributor Author

I've marked this PR as a draft until CDOT-CV#23 is merged.

…-2024

Addressing USDOT PR Comments 6/11/2024
@dmccoystephenson dmccoystephenson marked this pull request as ready for review June 11, 2024 19:07
@dmccoystephenson
Copy link
Contributor Author

This is ready for re-review @dan-du-car

@dan-du-car dan-du-car merged commit b58f5aa into usdot-jpo-ode:develop Jun 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants