Version-tab namespace key management how-to - #1511
Draft
8bitpal wants to merge 1 commit into
Draft
Conversation
The offline root namespace key procedure referenced examples/10-offline-root-namespace-init, an example folder removed in Canton 3.5.1 once its contents were folded into the how-to. The wider procedure was also stale: the old prepare-certs.sh script name, NIST P-256 instead of Ed25519, and a malformed embedded Scala block carried over verbatim from upstream. Reconvert the how-to from the current upstream sources with tools/rst-to-mdx and split it by Canton version: - "Online Root Namespace Key" is unchanged across versions and stays shared (sourced from 3.5). - "Offline Root Namespace Key" is tabbed: "Canton 3.5" (current MainNet, TestNet, and DevNet) is the default; "Canton 3.4" is retained verbatim for nodes still on a pre-3.5 release, where the examples/10-offline-root-namespace-init reference was valid. Also fix auto-resolved cross-references (crypto schemes reference, KMS operations), add code-fence languages, and drop three now-orphaned namespace_key snippet imports. Trim the malformed Scala block in the 3.4 tab to its one coherent statement with a divergence note. Fixes #1357 Signed-off-by: 8bitpal <elias@zerolimit.es>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
8bitpal
changed the title
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
1 participant
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.
Fixes #1357.
Problem
global-synchronizer/production-operations/key-management.mdxreferencedexamples/10-offline-root-namespace-init, an example folder removed in Canton 3.5.1 once its contents were folded into the how-to. The surrounding "Offline Root Namespace Key" procedure was also stale relative to current Canton: the oldprepare-certs.shscript name (nowprepare-cert.sh+assemble-cert.sh), NIST P-256 key generation instead of Ed25519, and a malformed embedded Scala block carried over verbatim from the upstream 3.4 source.Change
Reconverted the how-to from the current upstream sources with
tools/rst-to-mdxand split it by Canton version:prepare-cert.sh/assemble-cert.sh, Ed25519, and the restructured flow. Noexamples/10-...reference.examples/10-offline-root-namespace-initreference, which was valid for that release.Each tab carries its own
COPIED_START/ENDmarkers pointing at the matching upstream version. Follows the repo's existing full-duplication tab pattern (synchronizer-traffic.mdx,validator-docker-compose.mdx).Editorial fixes on the converted content
Using OpenSSL/Using GCP KMSdemoted to#####(sub-steps of step 4)/appdev/howtos/)<Note>namespace_key-{8,10,11}snippet importscode-block:: scalain "Pre-Generated Certificates" (a partial test-code paste with unbalanced braces in the upstream source) to its one coherent statement, with a divergence note; replaced two self-referential 404 links with plain textVerification
mintlify dev: page compiles, tabs render as interactive tabs, no MDX errorsmintlify broken-links: clean for this page and its link targetsNotes for reviewers