Skip to content

Reorganize Architecture chapter #557

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
Open
wants to merge 16 commits into
base: TDE_REL_17_STABLE
Choose a base branch
from
Open

Reorganize Architecture chapter #557

wants to merge 16 commits into from

Conversation

Andriciuc
Copy link
Collaborator

@Andriciuc Andriciuc commented Aug 28, 2025 •
edited
Loading

  • add initial new topics, split from Architecture.md. Now the user can see the following topics easier: Overview, Usage guide, Encryption internals, Key provider management topics
  • add introduction paragraph to some topics that were lacking it and improve clarity of the descriptions and content inside the topics
  • update ## Key providers (principal key storage) topic as it is outdated
  • fix links due to architecture.md being removed and updated TOC
  • remove last mentions of WAL being beta (I know this is out of scope, apologies)

@Andriciuc
Reorganize Architecture chapter
7b4d602 
- add initial new topics: overview, usage guide, encryption internals, key provider management topics
- move content for overview from architecture.md, pending others too
@Andriciuc Andriciuc added documentation Improvements or additions to documentation do not merge labels Aug 28, 2025
@Andriciuc
remove warning of WAL beta from wal_encryption variable
f3beb20 
- improve overview with cards
- change title to match ToC and not feel disjointed
- remove architecture.md since it is split now
- fix links
- rewrite Key providers (principal key storage) topic in key-prov-management as it contains out of date info
@Andriciuc Andriciuc marked this pull request as ready for review September 4, 2025 08:58
nastena1606
nastena1606 reviewed Sep 4, 2025
View reviewed changes
@Andriciuc
update overview.md with updated customizable support and extension ex…
a80bf9b 
…planation

- add intro paragraph for Encryption architecture to reflect data at rest capabilities explained below it
@Andriciuc
update overview and internals with clearer text
ff1300e 
- update variable for code branch
@Andriciuc
update text for clarity in SMGR API and WAL encryption
dab1384 
- add intro paragraph to key and key provider management
ImTheKai
ImTheKai requested changes Oct 2, 2025
View reviewed changes
@Andriciuc Andriciuc requested a review from ImTheKai October 6, 2025 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nastena1606 nastena1606 nastena1606 left review comments

@ImTheKai ImTheKai Awaiting requested review from ImTheKai

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Andriciuc @ImTheKai @nastena1606