Skip to content

docs: drop nova_audit and nova_vault name-drops from public surface #3

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

Merged
Taure merged 1 commit into from
May 20, 2026
Merged

docs: drop nova_audit and nova_vault name-drops from public surface #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ The S3 adapter works against AWS, Cloudflare R2, Scaleway Object, Minio, B2.
## Scope

`nova_storage` is intentionally narrow: bytes in, bytes out, signed URLs,
listing. Audit logs belong in `nova_audit`. Encryption-at-rest belongs in
`nova_vault`. Image transforms belong in a separate library.
listing. Audit logging, encryption-at-rest, and image transforms are
deliberately out of scope.

## Build

Expand Down
7 changes: 3 additions & 4 deletions src/nova_storage.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
-moduledoc """
Public API for the nova_storage library.

Object/file storage abstraction with pluggable adapters. Bytes-in / bytes-out;
encryption-at-rest is `nova_vault`'s job, audit is `nova_audit`'s.
Object/file storage abstraction with pluggable adapters. Bytes-in / bytes-out.

## Quick start

Expand Down Expand Up @@ -35,8 +34,8 @@ encryption-at-rest is `nova_vault`'s job, audit is `nova_audit`'s.
## Stability

`nova_storage` is NOT a dependency of nova core and must never become one.
Audit logging belongs in `nova_audit`. Encryption-at-rest belongs in
`nova_vault`. Image transforms belong in a separate library.
Audit logging, encryption-at-rest, and image transforms are deliberately
out of scope.
""".

-export([
Expand Down
Loading