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 #20

Merged
merged 13 commits into from
May 20, 2024

Conversation

dmccoystephenson
Copy link
Member

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

Copy link

@mwodahl mwodahl left a comment

Choose a reason for hiding this comment

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

Just two questions - looks good!

README.md Outdated

** IN PROGRESS! Further instructions pending ODE compatibility. **
```
docker compose -f docker-compose-confluent-cloud.yml up --build
Copy link

Choose a reason for hiding this comment

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

Should this be updated to the command for running the docker-compose.yml file instead of the confluent cloud file when running kafka locally?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, good catch! This has been fixed

sample.env Outdated
@@ -1,13 +1,14 @@
DOCKER_HOST_IP=
#SDW_GROUP_ID=usdot.jpo.sdw
Copy link

Choose a reason for hiding this comment

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

Should the SDW_GROUP_ID be removed from here? It looks like we're not passing it in as an environment variable in any of the docker compose files

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right it doesn't seem to be getting used. This has been removed from the sample.env and README.md files.

@dmccoystephenson dmccoystephenson requested a review from mwodahl May 15, 2024 22:22
Copy link

@mwodahl mwodahl left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link

@drewjj drewjj left a comment

Choose a reason for hiding this comment

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

This looks good to me!

@dmccoystephenson dmccoystephenson merged commit 87a7573 into develop May 20, 2024
3 checks passed
@dmccoystephenson dmccoystephenson deleted the docs/reviewing-and-revising-documentation branch May 20, 2024 21:57
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.

3 participants