Skip to content

Preparing general docs for GA release #434

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.

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

Draft
wants to merge 4 commits into
base: release-17.5.2
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 0 additions & 7 deletions contrib/pg_tde/documentation/_resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@
-#}
{% extends "base.html" %}

{% block announce %}
This is the <strong>Release Candidate 2 (RC2)</strong> of Percona Transparent Data Encryption (TDE) extension.
<p><strong>It is not recommended for production environments at this stage.</strong></p>
<p>We encourage you to test it and <a href= "https://forums.percona.com/c/postgresql/pg-tde-transparent-data-encryption-tde/82">give your feedback</a>.
This will help us improve the product and make it production-ready faster.</p>
{% endblock %}

{% block scripts %}
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
{{ super() }}
Expand Down
9 changes: 5 additions & 4 deletions contrib/pg_tde/documentation/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# pg_tde Documentation
# Percona Transparent Data Encryption for PostgreSQL documentation

`pg_tde` is the open source, community driven and futureproof PostgreSQL extension that provides Transparent Data Encryption (TDE) to protect data at rest. `pg_tde` ensures that the data stored on disk is encrypted, and that no one can read it without the proper encryption keys, even if they gain access to the physical storage media.
Percona Transparent Data Encryption for PostgreSQL (`pg_tde`) is an open-source, community driven and futureproof PostgreSQL extension that provides Transparent Data Encryption (TDE) to protect data at rest. `pg_tde` ensures that the data stored on disk is encrypted, and that no one can read it without the proper encryption keys, even if they gain access to the physical storage media.

!!! important
This is the {{release}} version of the extension and **it is not meant for production use yet**. We encourage you to use it in testing environments and [provide your feedback](https://forums.percona.com/c/postgresql/pg-tde-transparent-data-encryption-tde/82).
!!! warning "No upgrade path from RC to GA"
There is no safe upgrade path from the previous versions (such as Release Candidate 2) to the General Availability (GA) version of `pg_tde`.
We recommend starting with a **clean installation** for GA deployments. Avoid using RC environments in production.

[Overview](index/index.md){.md-button}
[Get Started](install.md){.md-button}
Expand Down
6 changes: 3 additions & 3 deletions contrib/pg_tde/documentation/docs/install.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Install pg_tde

<!-- !!! warning "No upgrade path from RC to GA"
There is no safe upgrade path from the Release Candidate 2 (RC2) to the General Availability (GA) version of `pg_tde`.
We recommend starting with a **clean installation** for GA deployments. Avoid using RC environments in production. -->
!!! warning "No upgrade path from RC to GA"
There is no safe upgrade path from the previous versions (such as Release Candidate 2) to the General Availability (GA) version of `pg_tde`.
We recommend starting with a **clean installation** for GA deployments. Avoid using RC environments in production.

To install `pg_tde`, use one of the following methods:

Expand Down
2 changes: 1 addition & 1 deletion contrib/pg_tde/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MkDocs general configuration

site_name: pg_tde documentation
site_name: Percona Transparent Data Encryption for PostgreSQL
site_description: Documentation
site_author: Percona LLC
copyright: >
Expand Down