Skip to content

Document sharing dynamic access keys with users - #9

Open
angelodlfrtr wants to merge 2 commits into
OutlineFoundation:mainfrom
angelodlfrtr:docs/dynamic-access-keys.md
Open

Document sharing dynamic access keys with users#9
angelodlfrtr wants to merge 2 commits into
OutlineFoundation:mainfrom
angelodlfrtr:docs/dynamic-access-keys.md

Conversation

@angelodlfrtr

Copy link
Copy Markdown

Add a "Share the Key with Your Users" section to the dynamic access keys page explaining the ssconf:// scheme: how to derive the key from the hosted configuration URL, naming the client entry with a URL fragment, and warnings that the key URL is a credential and that deleting the hosted configuration does not revoke access.

Translate the new section into all 17 locales, keeping code blocks identical to the English source as required by the translation verifier, and drop the now-unneeded verifier exceptions for this page along with a stale entry for vpn/advanced/websockets whose counts already match.

@greptile-apps

greptile-apps Bot commented Sep 1, 2026

Copy link
Copy Markdown

Greptile Summary

The PR documents how operators share dynamic access keys and strengthens translation link validation by replacing broad count exceptions with exact exclusions.

  • Explains ssconf:// conversion, display-name fragments, credential handling, and server-side revocation.
  • Adds expected translation differences for the new English-only content.
  • Preserves URL-by-URL checking after removing explicitly identified English-only links and validates reordered links as a set.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/vpn/management/dynamic-access-keys.md Adds accurate user-sharing, credential-protection, and revocation guidance for dynamic access keys.
scripts/verify_translations.py Replaces broad link-count exceptions with exact English-only link exclusions and validates known link swaps without leaving the previously reported URL-checking bypass.

Reviews (4): Last reviewed commit: "Validate translated links in docs with k..." | Re-trigger Greptile

Comment thread docs/vpn/management/dynamic-access-keys.md
Comment thread scripts/verify_translations.py Outdated
@angelodlfrtr
angelodlfrtr force-pushed the docs/dynamic-access-keys.md branch from 796779c to 52ca671 Compare September 1, 2026 14:36
@ohnorobo

ohnorobo commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

You can delete the translated additions. We don't use machine translation since we're not yet sure it's reliable enough and we're not able to double-check it. We intend to set up a translation pipeline with a vendor later, but for now we just keep new articles in english only.

Add a "Share the Key with Your Users" section to the dynamic access keys
page explaining the ssconf:// scheme: how to derive the key from the
hosted configuration URL, naming the client entry with a URL fragment,
and warnings that the key URL is a credential and that deleting the
hosted configuration does not revoke access.

Record the resulting code block, link, and admonition differences as
known exceptions in the translation verifier, matching how other
post-export English additions are handled, and drop a stale exception
for vpn/advanced/websockets whose counts already match.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@angelodlfrtr
angelodlfrtr force-pushed the docs/dynamic-access-keys.md branch from 52ca671 to a796283 Compare September 1, 2026 15:39
Comment thread scripts/verify_translations.py Outdated
Comment thread scripts/verify_translations.py Outdated
Replace the KNOWN_LINK_COUNT_DIFFS count exceptions, which skipped
URL-by-URL link comparison entirely for the affected docs, with a
KNOWN_ENGLISH_ONLY_LINKS table pinning the exact English link indices
that have no translated counterpart. Those indices are removed before
comparison and every remaining link must still match the translation
URL-by-URL, so an omitted, mistyped, or replaced localized destination
now fails verification.

Also validate KNOWN_LINK_SWAPS positions as a set, so a replaced URL at
a swapped position is caught instead of being skipped.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.

2 participants