Skip to content

PRDCT-612: port options.encryption_hint from developers-docs before the dev pages retire - #1087

Open
Iamfle4ka wants to merge 1 commit into
mainfrom
PRDCT-612-encryption-hint
Open

PRDCT-612: port options.encryption_hint from developers-docs before the dev pages retire#1087
Iamfle4ka wants to merge 1 commit into
mainfrom
PRDCT-612-encryption-hint

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

options.encryption_hint was 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 the options table.
  • 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, so options.encryption_hint: false hides 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 build clean, 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.
  • The anchor #codemirror-jsonsqlpython-editor resolves 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.

@linear-code

linear-code Bot commented Aug 7, 2026

Copy link
Copy Markdown

PRDCT-612

@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview Aug 7, 2026 5:38pm

Request Review

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
Iamfle4ka force-pushed the PRDCT-612-encryption-hint branch 2 times, most recently from 19d092d to 91145e8 Compare August 7, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant