Skip to content

Restructure the installation guide and move testing and CI to its own page #145

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

Open
susan-pgedge wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Restructure the installation guide and move testing and CI to its own page #145

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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ The ColdFront documentation consists of the following guides:
PostgreSQL column types, including arrays, that a cold tier supports.
- [Compacting the Cold Tier](docs/compaction.md) - Documents cold-tier
table maintenance: compaction, snapshot expiry, and orphan-file removal.
- [Testing and Continuous Integration](docs/testing_ci.md) - Documents the
pre-commit gate, the full test matrix, storage-backend gating, and
publishing the base image.
- Developer Resources
- [Formal Model - ColdFront Decoupled-Mode Bakery (TLA+/PlusCal)](docs/formal/README.md)
- [Release Notes - Changelog](docs/changelog.md)
Expand Down Expand Up @@ -373,7 +376,7 @@ creates.
The deployed image is for development and testing. It trusts every connection
without a password. For information about the image's environment variables
and a smoke test, see
[Building the Image on Docker](docs/installation.md#building-the-image-on-docker).
[Building ColdFront from Source on Docker](docs/installation.md#building-coldfront-from-source-on-docker).

When the extensions are created, continue with
[Connecting a Docker Installation to Lakekeeper and an Object Store](#connecting-a-docker-installation-to-lakekeeper-and-an-object-store).
Expand All @@ -382,9 +385,11 @@ When the extensions are created, continue with

Before building ColdFront on bare metal, install the pg_duckdb PostgreSQL
extension (built on DuckDB 1.5.4, with ColdFront's pg_duckdb and DuckDB patches
applied) and a patched duckdb-iceberg DuckDB extension. For the prerequisites
and the patches, see
[Building ColdFront from Source](docs/installation.md#building-coldfront-from-source).
applied) and a patched duckdb-iceberg DuckDB extension. For the prerequisites,
see
[Building ColdFront from Source on Bare Metal](docs/installation.md#building-coldfront-from-source-on-bare-metal);
for the patches, see
[Understanding ColdFront's DuckDB Stack](docs/installation.md#understanding-coldfronts-duckdb-stack).
You also need a running PostgreSQL 16, 17, or 18 server, `pg_config`, the
PostgreSQL server development headers, the libpq headers and library, `make`,
`gcc`, Go 1.26.10 or later, and golangci-lint.
Expand Down Expand Up @@ -456,7 +461,7 @@ PostgreSQL server development headers, the libpq headers and library, `make`,
`CREATE EXTENSION` commands in each database that uses ColdFront.

For more information, see
[Building ColdFront on Bare Metal](docs/installation.md#building-coldfront-on-bare-metal).
[Building ColdFront from Source on Bare Metal](docs/installation.md#building-coldfront-from-source-on-bare-metal).

When the extensions are created, continue with
[Connecting a Package or Bare-Metal Installation to Lakekeeper and an Object Store](#connecting-a-package-or-bare-metal-installation-to-lakekeeper-and-an-object-store).
Expand Down
2 changes: 1 addition & 1 deletion docs/configure_lakekeeper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ The image writes the server settings ColdFront needs into `postgresql.conf`
when it initializes a new data directory. A server installed from packages or
built another way sets them itself, as the
[package](configuration.md#configuring-postgresql) and
[bare-metal](installation.md#building-coldfront-on-bare-metal) sections of
[bare-metal](installation.md#building-coldfront-from-source-on-bare-metal) sections of
installation.md show:

- `shared_preload_libraries = 'pg_duckdb,coldfront'` loads both extensions at
Expand Down
Loading
Loading