Skip to content

Commit

Permalink
docs(journal Add doc.go): Add go documentation for the journal servic…
Browse files Browse the repository at this point in the history
…e, events and middleware package in journal service

Signed-off-by: Rodney Osodo <[email protected]>
  • Loading branch information
rodneyosodo committed Jun 26, 2024
1 parent e9f64a5 commit 19b7fb5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
7 changes: 7 additions & 0 deletions journal/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

// Package journal contains the journal service.
// This service is responsible for storing events from the event store to a
// journal log repository. It is also responsible for providing a REST API to query events.
package journal
7 changes: 7 additions & 0 deletions journal/events/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

// Package events provides the event consumer for the journal service.
// This package is responsible for consuming events from the event store and
// processing them.
package events
6 changes: 6 additions & 0 deletions journal/middleware/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

// Package middleware provides middleware for the journal service.
// This is logging, metrics, and tracing middleware.
package middleware

0 comments on commit 19b7fb5

Please sign in to comment.