Docs #19
Merged
Docs #19
Conversation
This file contains hidden or 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
Introduces DB_MODEL.md with detailed schema definitions, design principles, table structures, recommended indexes, upsert patterns, migration strategy, retention/archival guidance, validation queries, and DBML for visualization. This document serves as the canonical reference for backend, ETL, and data engineering teams.
Add canonical StarForge database model documentation
Created docs/ETL_AND_WORKER.md to provide documentation related to ETL processes and worker components.
Introduces a comprehensive ETL and worker design document for StarForge, covering architecture, input contracts, queue and retry semantics, upsert SQL patterns, error handling, monitoring, logging, admin APIs, testing strategies, security, and operational runbooks. This serves as a reference for backend, DevOps, QA, and data engineers implementing and operating the ETL pipeline.
Elt and worker
Introduces a new OBSERVABILITY.md file in the docs directory. Content to be added in future commits.
Introduces OBSERVABILITY.md detailing metrics, logging, tracing, dashboards, alerting, and PII handling for StarForge services. Provides implementation guidance, sample configurations, and operational runbooks for engineers and SREs.
Observability
Introduces a new MIGRATIONS.md file in the docs directory. This file will be used to document migration steps and related information.
Introduces MIGRATIONS.md, a detailed guide covering principles, tooling, safe patterns, CI integration, rollback, review criteria, and operational runbooks for managing database schema migrations using node-pg-migrate. Includes templates, preflight scripts, and best practices for safe, auditable, and testable migrations.
Deleted docs/DB_MIGRATIONS.md, which contained guidelines and best practices for managing database migrations in the project.
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.
No description provided.