Reorganize toc / overview chapter / update topic headings #468
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reorganized how the ToC website interaction is done by renaming index.md from CLI, architecture, advanced topics, KMS and Overview (index folder). This meant updating links in multiple other files as index files needed to be renamed for the structure to work. Reorganized how Overview is displayed, removed RC2 mention in Limitations, removed important note as it is no longer needed since it was an RC2 mention. Reworded the button texts for better interaction and user expectation in the Overview chapter topics. Added a short intro for Benefits of pg_tde topic, rewrote admonition. Updated KMS titles to reflect Percona Style Guide.
Andriciuc
changed the title
Andriciuc
changed the title
…nce-and-fix-webnav
…nce-and-fix-webnav
AndersAstrand
requested changes
Jul 24, 2025
There was a problem hiding this comment.
There was one mention of "encryption keys" that should probably be "decryption keys" instead. Looks good other than that.
I do think that confusing bullet point should be removed from "limitations" as it reads like it refers to the actual encryption keys which is not the case, but removing that is probably not in scope for this PR.
nastena1606
temporarily deployed
to
improve-overview-docnav-experience-and-fix-webnav - INTERNAL-pg_tde docs PR #468
Render
Destroyed
…nce-and-fix-webnav
AndersAstrand
approved these changes
Jul 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reorganized how the ToC website interaction is done by renaming index.md from CLI, architecture, advanced topics, KMS and Overview (index folder). This meant updating links in multiple other files as index files needed to be renamed for the structure to work.
Reorganized how Overview is displayed, removed RC2 mention in Limitations, removed important note as it is no longer needed since it was an RC2 mention.
Reworded the button texts for better interaction and user expectation in the Overview chapter topics.
Added a short intro for Benefits of pg_tde topic, rewrote admonition. Updated KMS titles to reflect Percona Style Guide.