Skip to content

Commit c5ee002

Browse files
OffgridwithJDclaude
andcommitted
docs: reorganize documentation and reset release history to the fork
Rework the documentation into a clearer structure and remove content that does not apply to open_pg_tde. Structure: - Move internal design docs from docs/design/ to a repo-root design/ directory so the repo no longer has both docs/ and documentation/ at the root. - Rename site folders to describe their contents: index/ -> concepts/, global-key-provider-configuration/ -> key-management/, advanced-topics/ -> reference/. Update all internal links and the README. - Rebuild the nav: drop numeric prefixes, add the previously orphaned contribute and pg-tde-upgrade pages, and point the README at the published site instead of the documentation/ directory tree. Release notes: - Remove the pre-fork Percona pg_tde lineage (MVP through 2.2.1). open_pg_tde's history starts at 2.3.0. Update variables.yml and the index accordingly. Consolidation: - Merge usage-guide into functions.md, restore-backups into backup-wal-enabled, the three KMIP vendor stubs into kmip-servers, supported-versions into install, and documentation-contributing into contribute. Delete tech-reference. Cleanup: - Remove dead assets (rating widget, promptremover.js, missing version-select.js reference, postgresql.css, Percona icon, unused SCSS) and prune requirements. Accuracy: - Fix the default cipher (AES-128-XTS, not CBC), the KMIP parameter order, the temp-file encryption description, the inherit_global_providers GUC name, the impact-table icons, the pg_stat_monitor example, and several typos. mkdocs build --strict passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent cb1a77a commit c5ee002

76 files changed

Lines changed: 238 additions & 1897 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ Maintainers cutting a release build one source tarball per supported PostgreSQL
9595
9696
## Documentation contribution
9797
98-
To contribute to the documentation, see the [documentation contributing guide](documentation/documentation-contributing.md).
98+
To contribute to the documentation, see the [contributing guide](documentation/docs/contribute.md).

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ required.
2525

2626
> `open_pg_tde` is an open fork of `pg_tde`,
2727
> maintained by [Command Prompt, Inc.](https://www.commandprompt.com/) See how
28-
> they differ in the [comparison with pg_tde](documentation/docs/index/comparison-percona.md).
28+
> they differ in the [comparison with pg_tde](documentation/docs/concepts/comparison-percona.md).
2929
3030
## Features
3131

3232
- **Per-table encryption** with the `tde_heap` access method. The cipher is
3333
recorded per table, so encrypted and plain tables coexist.
3434
- **Encrypted at rest:** table data, indexes, TOAST, the WAL, and temporary
3535
(query-spill) files. System catalogs and statistics are not encrypted; see the
36-
[threat model](documentation/docs/index/threat-model.md).
36+
[threat model](documentation/docs/concepts/threat-model.md).
3737
- **Data ciphers:** AES-128-XTS (default), AES-256-XTS, AES-128-CBC, and
3838
AES-256-CBC, selected with [`open_pg_tde.data_cipher`](documentation/docs/variables.md).
3939
The WAL uses AES-CTR.
@@ -42,7 +42,7 @@ required.
4242
[OpenBao](https://openbao.org/) as providers, per database or cluster-wide.
4343
- **FIPS:** all cryptography runs through OpenSSL with FIPS-approved modes, and
4444
the server can be required to start only in OpenSSL FIPS mode. See
45-
[FIPS compliance](documentation/docs/index/fips.md).
45+
[FIPS compliance](documentation/docs/concepts/fips.md).
4646
- **Upstream PostgreSQL:** a gated core patch adds the storage-manager and WAL
4747
hooks. With the flag off, the tree builds as unmodified PostgreSQL.
4848

@@ -53,7 +53,7 @@ required.
5353
| 18 | Supported |
5454
| 17 | Supported |
5555
| 16 | Supported (minimum) |
56-
| 19 | Beta port in progress ([roadmap](docs/design/encryption-roadmap.md#postgresql-version-support)) |
56+
| 19 | Beta port in progress ([roadmap](design/encryption-roadmap.md#postgresql-version-support)) |
5757

5858
## Installation
5959

@@ -93,17 +93,19 @@ encryption, and enabling encryption by default.
9393

9494
## Documentation
9595

96-
The full documentation source is in [`documentation/`](documentation/).
96+
The full documentation is published at
97+
**[commandprompt.github.io/open_pg_tde](https://commandprompt.github.io/open_pg_tde/)**.
98+
The Markdown source lives in the `documentation/` directory of this repository.
9799

98100
| | |
99101
| --- | --- |
100102
| [Setup and configuration](documentation/docs/setup.md) | Install, key providers, encrypted tables |
101-
| [Key management](documentation/docs/global-key-provider-configuration/overview.md) | Keyring file, KMIP, OpenBao |
103+
| [Key management](documentation/docs/key-management/overview.md) | Keyring file, KMIP, OpenBao |
102104
| [GUC variables](documentation/docs/variables.md) | All settings |
103105
| [Functions](documentation/docs/functions.md) | Helper functions |
104-
| [Threat model](documentation/docs/index/threat-model.md) | What encryption at rest does and does not protect |
105-
| [FIPS compliance](documentation/docs/index/fips.md) | Approved algorithms and FIPS mode |
106-
| [Comparison with Percona pg_tde](documentation/docs/index/comparison-percona.md) | How the fork differs |
106+
| [Threat model](documentation/docs/concepts/threat-model.md) | What encryption at rest does and does not protect |
107+
| [FIPS compliance](documentation/docs/concepts/fips.md) | Approved algorithms and FIPS mode |
108+
| [Comparison with Percona pg_tde](documentation/docs/concepts/comparison-percona.md) | How the fork differs |
107109

108110
## Contributing
109111

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

documentation/_resource/.icons/percona/logo.svg

Lines changed: 0 additions & 3 deletions
This file was deleted.

documentation/_resource/templates/styles.scss

Lines changed: 0 additions & 118 deletions
This file was deleted.

documentation/docs/advanced-topics/tech-reference.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)