PRDCT-612: port options.encryption_hint from developers-docs before the dev pages retire - #1087
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The dev copy of these two pages was updated on 2026-08-04 (dd30fdf8, Jakub Kotek, docs half of keboola/ui#7627) — five days after the same pages merged into help. That edit exists only on developers-docs, so the delete-from-dev PR (developers-docs#406) would retire it: exactly the case Jordan flagged on the 08-05 sync, "something on a components page which we already moved, but now it exists only on developer docs — make sure that also gets handled." Ports both hunks verbatim, with two adjustments for the help side: - the `---` in the prose becomes a real em dash, per the corpus-wide sweep; - the cross-link keeps the local convention `/overview/encryption/`, matching the three existing links on neighbouring /extend/ pages. Note the audit's broken-link count goes 35 → 36 for that reason: /overview/ has not been migrated yet, so every link to it is a known forward-ref that resolves when that unit lands. The anchor #codemirror-jsonsqlpython-editor resolves today. Unblocks developers-docs#406, which is approved and only conflicts on these two files.
Iamfle4ka
force-pushed
the
PRDCT-612-encryption-hint
branch
2 times, most recently
from
August 7, 2026 17:37
19d092d to
91145e8
Compare
keboola-pr-reviewer-bot
approved these changes
Aug 25, 2026
keboola-pr-reviewer-bot
left a comment
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: auto_approve (risk 2/5) · profile connection-docs
Auto-approve: content-only port of the already-documented encryption_hint option into help docs; the one new internal link is a known forward-reference matching repo convention.
Concerns:
src/content/docs/extend/component/ui-options/configuration-schema/examples/index.md: Added link /overview/encryption/ 404s at HEAD; known forward-ref, matches six existing pages
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
options.encryption_hintwas documented on developers-docs on 2026-08-04 (dd30fdf8, Jakub Kotek — the docs half of keboola/ui#7627), five days after the same two pages merged into help. The edit therefore exists only on the dev copy, and developers-docs#406 — the delete-from-dev PR, already approved — would retire it.This is the case Jordan named on the 08-05 sync: "there's something on a components page which we already moved, but now it exists only on developer docs — make sure that also gets handled." It is also why #406 conflicts: the only two files it cannot merge cleanly are these two.
What it adds
configuration-schema/index.md— one row in theoptionstable.configuration-schema/examples/index.md— the paragraph and JSON example under Codemirror (json/sql/python..) Editor: a JSON-mode editor stores parsed JSON, so#-prefixed keys inside it are encrypted on save and the UI says so; when the field does not hold Keboola configuration that note advertises something the component cannot use, sooptions.encryption_hint: falsehides it. Encryption behaviour itself is unchanged.Ported verbatim, with two adjustments for the help side: the
---in the prose becomes a real em dash (per the corpus-wide sweep in #1069/#1070), and the encryption cross-link uses the local/overview/encryption/convention that three neighbouring/extend/pages already use.Verification
npm run buildclean, 308 pages.node scripts/audit-phase2.mjs: 0 missing images. Broken internal links go 35 → 36, and the one added is/extend/component/ui-options/configuration-schema/examples/ → /overview/encryption/— a known forward-ref, since/overview/has not been migrated yet. It resolves when that unit lands; the alternative was an absolute link to a site we are retiring.#codemirror-jsonsqlpython-editorresolves on the target page today.Merge order
This first, then rebase and merge developers-docs#406. Merging #406 first would drop the content from the live docs entirely.