Add Gitea NuGet publish workflow and finalize current storage/index/docs updates.
This commit is contained in:
40
README.md
40
README.md
@@ -10,21 +10,21 @@ CBDD provides a local data layer for services and tools that need transactional
|
||||
|
||||
- Owning team: CBDD maintainers (repository owner: `@dohertj2`)
|
||||
- Primary support path: open a Gitea issue in this repository with labels `incident` or `bug`
|
||||
- Escalation path: follow `/Users/dohertj2/Desktop/CBDD/docs/runbook.md` and page the release maintainer listed in the active release PR
|
||||
- Escalation path: follow [`docs/runbook.md`](docs/runbook.md) and page the release maintainer listed in the active release PR
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
CBDD has four primary layers:
|
||||
|
||||
1. Storage and transaction engine (`/Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage`, `/Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Transactions`)
|
||||
2. BSON serialization (`/Users/dohertj2/Desktop/CBDD/src/CBDD.Bson`)
|
||||
3. Indexing and query execution (`/Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing`, `/Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query`)
|
||||
4. Source-generated mapping (`/Users/dohertj2/Desktop/CBDD/src/CBDD.SourceGenerators`)
|
||||
1. Storage and transaction engine (`src/CBDD.Core/Storage`, `src/CBDD.Core/Transactions`)
|
||||
2. BSON serialization (`src/CBDD.Bson`)
|
||||
3. Indexing and query execution (`src/CBDD.Core/Indexing`, `src/CBDD.Core/Query`)
|
||||
4. Source-generated mapping (`src/CBDD.SourceGenerators`)
|
||||
|
||||
Detailed architecture material:
|
||||
- `/Users/dohertj2/Desktop/CBDD/docs/architecture.md`
|
||||
- `/Users/dohertj2/Desktop/CBDD/RFC.md`
|
||||
- `/Users/dohertj2/Desktop/CBDD/C-BSON.md`
|
||||
- [`docs/architecture.md`](docs/architecture.md)
|
||||
- [`RFC.md`](RFC.md)
|
||||
- [`C-BSON.md`](C-BSON.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -94,29 +94,29 @@ bash scripts/fitness-check.sh
|
||||
|
||||
CBDD is released as an internal package.
|
||||
|
||||
- Deployment workflow: `/Users/dohertj2/Desktop/CBDD/docs/deployment.md`
|
||||
- Rollback workflow: `/Users/dohertj2/Desktop/CBDD/docs/deployment.md#rollback-procedure`
|
||||
- Deployment workflow: [`docs/deployment.md`](docs/deployment.md)
|
||||
- Rollback workflow: [`docs/deployment.md#rollback-procedure`](docs/deployment.md#rollback-procedure)
|
||||
|
||||
## Operations And Incident Response
|
||||
|
||||
Operational procedures, diagnostics, and escalation are documented in:
|
||||
|
||||
- `/Users/dohertj2/Desktop/CBDD/docs/runbook.md`
|
||||
- `/Users/dohertj2/Desktop/CBDD/docs/troubleshooting.md`
|
||||
- [`docs/runbook.md`](docs/runbook.md)
|
||||
- [`docs/troubleshooting.md`](docs/troubleshooting.md)
|
||||
|
||||
## Security And Compliance Posture
|
||||
|
||||
- CBDD relies on host and process-level access controls.
|
||||
- Sensitive payload classification and handling requirements are defined in `/Users/dohertj2/Desktop/CBDD/docs/security.md`.
|
||||
- Role and approval requirements are defined in `/Users/dohertj2/Desktop/CBDD/docs/access.md`.
|
||||
- Sensitive payload classification and handling requirements are defined in [`docs/security.md`](docs/security.md).
|
||||
- Role and approval requirements are defined in [`docs/access.md`](docs/access.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and remediation:
|
||||
|
||||
- Build/test environment failures: `/Users/dohertj2/Desktop/CBDD/docs/troubleshooting.md#build-and-test-failures`
|
||||
- Data-file recovery procedures: `/Users/dohertj2/Desktop/CBDD/docs/troubleshooting.md#data-file-and-recovery-issues`
|
||||
- Query/index behavior verification: `/Users/dohertj2/Desktop/CBDD/docs/troubleshooting.md#query-and-index-issues`
|
||||
- Build/test environment failures: [`docs/troubleshooting.md#build-and-test-failures`](docs/troubleshooting.md#build-and-test-failures)
|
||||
- Data-file recovery procedures: [`docs/troubleshooting.md#data-file-and-recovery-issues`](docs/troubleshooting.md#data-file-and-recovery-issues)
|
||||
- Query/index behavior verification: [`docs/troubleshooting.md#query-and-index-issues`](docs/troubleshooting.md#query-and-index-issues)
|
||||
|
||||
## Change Governance
|
||||
|
||||
@@ -127,6 +127,6 @@ Common issues and remediation:
|
||||
|
||||
## Documentation Index
|
||||
|
||||
- Documentation home: `/Users/dohertj2/Desktop/CBDD/docs/README.md`
|
||||
- Major feature inventory: `/Users/dohertj2/Desktop/CBDD/docs/features/README.md`
|
||||
- Architecture decisions: `/Users/dohertj2/Desktop/CBDD/docs/adr/0001-storage-engine-and-source-generation.md`
|
||||
- Documentation home: [`docs/README.md`](docs/README.md)
|
||||
- Major feature inventory: [`docs/features/README.md`](docs/features/README.md)
|
||||
- Architecture decisions: [`docs/adr/0001-storage-engine-and-source-generation.md`](docs/adr/0001-storage-engine-and-source-generation.md)
|
||||
|
||||
Reference in New Issue
Block a user