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.

Sign up for GitHub

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

Jump to bottom

Revised Documentation for Accuracy #25

Merged
merged 17 commits into from
May 20, 2024
Merged

Revised Documentation for Accuracy #25

merged 17 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

README.md

  • Fixed a typo ("Metatdata" instead of "Metadata")
  • Adjusted headers to improve clarity
  • Removed outdated 'Project Management' section in README
  • Moved 'Confluent Cloud Integration' section to bottom of README

installation.md

  • Adjusted headers & added table of contents to installation.md
  • Moved 'Docker Installation' section to top of installation.md
  • Heavily revised the docker/manual installation documentation in installation.md to ensure accuracy

interface.md

  • Adjusted headers
  • Fixed a typo (heirarchy instead of hierarchy)

configuration.md

  • Fixed a typo
  • Adjusted headers
  • Revised ACM Testing with Kafka section

testing.md

  • Reorganized document
  • Added docker info

@dmccoystephenson
Fixed a typo in the README (Metatdata -> Metadata)
3d02392
@dmccoystephenson
Adjusted headers in README to improve clarity
9f6e025
@dmccoystephenson
Removed outdated 'Project Management' section in README
e46229a
@dmccoystephenson
Moved 'Confluent Cloud Integration' section to bottom of README
e321d24
@dmccoystephenson
Adjusted headers & added table of contents to installation.md
401ffe5
@dmccoystephenson
Moved 'Docker Installation' section to top of installation.md
223c81c
@dmccoystephenson
Revised docker & manual installation documentation in installation.md
65bf902
@dmccoystephenson
Adjusted headers in interface.md
84d39ea
@dmccoystephenson
Fixed typo in interface.md (heirarchy -> hierarchy)
509c835
@dmccoystephenson
Fixed a typo in configuration.md (Metatdata -> Metadata)
07da37c
@dmccoystephenson
Adjusted headers in configuration.md
9ac4e23
@dmccoystephenson
Revised 'ACM Testing with Kafka' section of configuration.md
727bfc7
@dmccoystephenson
Reorganized testing.md and added docker info
1982b76
@dmccoystephenson
Added more instructions on env file handling to installation.md
5ed3d97
mwodahl
mwodahl approved these changes May 15, 2024
View reviewed changes
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 to me!

drewjj
drewjj approved these changes May 17, 2024
View reviewed changes
Copy link
Collaborator

@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!

@dmccoystephenson dmccoystephenson merged commit 36dd778 into develop May 20, 2024
4 checks passed
@dmccoystephenson dmccoystephenson deleted the docs/reviewing-and-revising-documentation branch May 20, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drewjj drewjj drewjj approved these changes

@mwodahl mwodahl mwodahl approved these changes

@payneBrandon payneBrandon Awaiting requested review from payneBrandon

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dmccoystephenson @drewjj @mwodahl