8000 Tde documentation updates for ga by Andriciuc · Pull Request #251 · percona/postgres · GitHub
[go: up one dir, main page]
Skip to content

Tde documentation updates for ga #251

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

Jump to bottom
Merged
merged 31 commits into from
May 8, 2025
Merged

Tde documentation updates for ga #251

merged 31 commits into from
May 8, 2025

Conversation

Andriciuc
Copy link
Collaborator

initial PR

@Andriciuc
Added and reorg files
fdd464b 
Added replication.md for replication implication in pg_tde, moved architecture.md in architecture folder and renamed to index.md to improve SEO and further refine doc structure.

Small fixes to features.md
@Andriciuc
Split Home and created TDE Overview 8000
f3d8379 
Home now points to index.md and added a new TOC link called TDE Overview which contains what index had, tde encrypts, limitations and versions, this will help a lot to further build up TDE in proper sections/topics rather than having a one big file.

Also updated mkdocs for this.
@Andriciuc
Further refined and split into topics
e2d4be2 
Split tde.md into:
What is TDE
How does TDE work
Why do you need it
Moved into how_to:
uninstall.md
decrypt
external param
multi-t-setup
Updated yaml structure, Overview now includes more details about TDE from above topics
@Andriciuc
Renamed files and folders for better SEO
f5db064 
Renamed a lot of the files in index and how_to (now how-to) to have better SEO
@Andriciuc
Merge remote-tracking branch 'origin/pg_tde_docs_updates_for_GA' into…
4869f64 
… TDE-documentation-updates-for-GA
@codecov-commenter
Copy link
codecov-commenter commented Apr 23, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.29%. Comparing base (784e45d) to head (7b76758).
Report is 1 commits behind head on TDE_REL_17_STABLE.

❌ Your project status has failed because the head coverage (80.29%) is below the target coverage (90.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files 
@@                Coverage Diff                 @@
##           TDE_REL_17_STABLE     #251   +/-   ##
==================================================
  Coverage              80.29%   80.29%           
==================================================
  Files                     22       22           
  Lines                   2578     2578           
  Branches                 396      396           
==================================================
  Hits                    2070     2070           
  Misses                   428      428           
  Partials                  80       80
Components Coverage Δ
access 82.77% <ø> (ø)
catalog 87.47% <ø> (ø)
common 91.80% <ø> (ø)
encryption 75.70% <ø> (ø)
keyring 71.83% <ø> (ø)
src 66.74% <ø> (ø)
smgr 97.00% <ø> (ø)
transam ∅ <ø> (∅)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Andriciuc
updated with Anders branch
ed361e7 
Modified root to secret token access for mount point
@Andriciuc Andriciuc self-assigned this Apr 28, 2025
@Andriciuc Andriciuc added the documentation Improvements or additions to documentation label Apr 28, 2025
@Andriciuc
updated links to reflect proper structure
cbd4017 
I also updated the ToC links
@Andriciuc
Setup.md and structure changes
778851b 
Split setup.md into setup.md (for local keys) and a separate tde install for global key manager with multiple KMS's.

Fixed a bit the ToC as links were renewed, updated content with small improvements for better flow.

Added key config for keyring, kmip and vault.
@Andriciuc
A handful of fixes
1e3c160 
created principal key file and updated the flow of the docs, TOC, fixes to texts and updated the way we present sql commands
@Andriciuc
all fixes accounted for
104710e 
fixed a lot of other minor issues but this is the last commit before merge
@Andriciuc Andriciuc requested a review from nastena1606 May 7, 2025 15:24
@Andriciuc
fixes to titles
31bea87 
fixed title style across docs
@Andriciuc
fixed notes in features
be6e6ef 
and fixed mkdocs serve utility
@Andriciuc
updated function parameters
7b76758 
Updated from default true to false as per Commit f636e82 comments
@nastena1606 nastena1606 temporarily deployed to TDE-documentation-updates-for-GA - INTERNAL-pg_tde docs PR #251 May 8, 2025 08:37 — with Render Destroyed
@nastena1606 nastena1606 temporarily deployed to TDE-documentation-updates-for-GA - pg-tde-docs PR #251 May 8, 2025 08:37 — with Render Destroyed
AndersAstrand
AndersAstrand approved these changes May 8, 2025
View reviewed changes
Copy link
Collaborator
@AndersAstrand AndersAstrand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please squash before merging though :).

@Andriciuc Andriciuc merged commit 03106ed into TDE_REL_17_STABLE May 8, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeltz jeltz jeltz left review comments

@nastena1606 nastena1606 nastena1606 left review comments

@AndersAstrand AndersAstrand AndersAstrand approved these changes

Assignees

@Andriciuc Andriciuc

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Andriciuc @codecov-commenter @jeltz @AndersAstrand @mohitj1988 @nastena1606
0