MemberInfo. The MGM and the group member sign over the MemberInfo to confirm the validity of the information from Kafka, which may be for a different identity and/or flow."
+ },
+ "Membership group": {
+ "definition": "A logical grouping of multiple Corda identities, which communicate and transact with each other using a specific set of CorDapps.",
+ "more": ""
+ },
+ "Membership worker": {
+ "definition": "A worker that manages the peer-to-peer routing information available to virtual nodes. The membership workers communicate periodically with the MGM to ensure they have up-to-date network information on peers. This MGM communication is secured via the Link Manager protocols.",
+ "more": "If the Corda cluster is hosting a Membership Group Manager(MGM), then the Membership worker is also responsible for hosting the administrative and broadcast functions of the MGM. For information about Corda workers, see Workers."
+ },
+ "MGM": {
+ "definition": "Membership Group Manager. May also be referred to as the Network Manager. It is a virtual node and Corda identity that acts as a central registrar for group membership. ",
+ "more": "The CPI files point at the MGM server, so that when a virtual node is created, the node contains the PKI policies and addresses the MGM. The MGM server is responsible for accepting membership proposals. For users coming from Corda 4, MGM replaces CENM. For more information, see Onboarding the MGM."
+ },
+ "PKI": {
+ "definition": "Public key infrastructure. A comprehensive system of hardware, software, policies, and procedures that enables the secure creation, distribution, management, and revocation of digital certificates and public-key cryptography.",
+ "more": ""
+ },
+ "P2P Link Manager": {
+ "definition": "Establishes end-to-end secure sessions for virtual nodes to communicate over.",
+ "more": "The Link Manager uses the data provided to it by the membership worker to translate virtual node names on CorDapp packets to physical HTTPS destination addresses and requests the gateway worker to transmit its secured packets to the peers. If packets cannot be delivered, the Link Manager also manages redelivery, possibly via alternate gateway workers."
+ },
+ "P2P Link Manager worker": {
+ "definition": "A worker that manages the secure transmission of packets to peers. The main functional component is the Link Manager, which establishes end-to-end secure sessions for virtual nodes to communicate over.",
+ "more": "For information about Corda workers, see Workers."
+ },
+ "RBAC": {
+ "definition": "Role-based access control. Also known as role-based security. A permission system to restrict system access based on assigned permissions.",
+ "more": "For more information, see Configuring Users."
+ },
+ "REST user identity": {
+ "definition": "A login to the REST endpoint. Each login is associated with customizable permissions on the cluster and virtual nodes.",
+ "more": ""
+ },
+ "REST worker": {
+ "definition": "A worker that exposes the intranet HTTPS REST control ports of the Corda cluster. The REST workers support all of the dynamic administration APIs of the cluster, such as APIs to configure the cluster, set up user role based permissions, or create and register virtual nodes. ",
+ "more": "REST workers also provide the virtual node endpoint APIs for invoking the flows and the ledger applications, and for retrieving their status/results. All REST calls must be authenticated and authorized, typically using OAUTH2 for login/authentication and Role Based Access Controls checked against a user permissions database. For information about Corda workers, see Workers."
+ },
+ "Revocation check": {
+ "definition": "In the context of X.509 certificates, revocation checks refer to the process of verifying if a digital certificate is still valid and has not been revoked by the issuing Certificate Authority (CA). ",
+ "more": "Revocation checks are typically performed using mechanisms such as Certificate Revocation Lists (CRLs) or the Online Certificate Status Protocol (OCSP), which provide up-to-date information on the revocation status of certificates."
+ },
+ "Sandbox": {
+ "definition": "An execution environment within a JVM process that provides isolation for a CorDapp. It shields it from outside threats but it also restricts what it can do so that running potentially dangerous code cannot harm others.",
+ "more": "While CorDapp writers trust their own code, they can not trust CorDapps written by others, so Corda, as an application hosting platform, treat CorDapps as untrusted code that could be malicious."
+ },
+ "Session identity": {
+ "definition": "Validates the end-to-end connectivity between virtual nodes.",
+ "more": ""
+ },
+ "Session initiation key": {
+ "definition": "The key for a virtual node, which is published in the `MemberInfo`, and used by Link Managers to authenticate and establish secure messaging sessions between network members.",
+ "more": ""
+ },
+ "Session trustroot": {
+ "definition": "The highest-level or root certificate in a certificate chain that is established during a secure communication session. This root certificate is issued by a trusted Certificate Authority (CA) and serves as the ultimate authority for validating the authenticity and trustworthiness of other certificates in the chain. ",
+ "more": "A transport layer security (TLS) communications session established between two endpoints needs to share a common trustroot; this is typically a root certificate authority with a secured private key. By validating the session trust root, an application or user can ensure the integrity and security of the entire certificate chain, leading to the establishment of a secure and encrypted connection between the communicating parties."
+ },
+ "Smart contract": {
+ "definition": "Digitizes agreements by turning the contract terms into code that executes automatically when the terms are met. ",
+ "more": "This means that:MemberInfo. The MGM and the group member sign over the MemberInfo to confirm the validity of the information from Kafka, which may be for a different identity and/or flow."
+ },
+ "Membership group": {
+ "definition": "A logical grouping of multiple Corda identities, which communicate and transact with each other using a specific set of CorDapps.",
+ "more": ""
+ },
+ "Membership worker": {
+ "definition": "A worker that manages the peer-to-peer routing information available to virtual nodes. The membership workers communicate periodically with the MGM to ensure they have up-to-date network information on peers. This MGM communication is secured via the Link Manager protocols.",
+ "more": "If the Corda cluster is hosting a Membership Group Manager(MGM), then the Membership worker is also responsible for hosting the administrative and broadcast functions of the MGM. For information about Corda workers, see Workers."
+ },
+ "MGM": {
+ "definition": "Membership Group Manager. May also be referred to as the Network Manager. It is a virtual node and Corda identity that acts as a central registrar for group membership. ",
+ "more": "The CPI files point at the MGM server, so that when a virtual node is created, the node contains the PKI policies and addresses the MGM. The MGM server is responsible for accepting membership proposals. For users coming from Corda 4, MGM replaces CENM. For more information, see Onboarding the MGM."
+ },
+ "PKI": {
+ "definition": "Public key infrastructure. A comprehensive system of hardware, software, policies, and procedures that enables the secure creation, distribution, management, and revocation of digital certificates and public-key cryptography.",
+ "more": ""
+ },
+ "P2P Link Manager": {
+ "definition": "Establishes end-to-end secure sessions for virtual nodes to communicate over.",
+ "more": "The Link Manager uses the data provided to it by the membership worker to translate virtual node names on CorDapp packets to physical HTTPS destination addresses and requests the gateway worker to transmit its secured packets to the peers. If packets cannot be delivered, the Link Manager also manages redelivery, possibly via alternate gateway workers."
+ },
+ "P2P Link Manager worker": {
+ "definition": "A worker that manages the secure transmission of packets to peers. The main functional component is the Link Manager, which establishes end-to-end secure sessions for virtual nodes to communicate over.",
+ "more": " For information about Corda workers, see Workers."
+ },
+ "RBAC": {
+ "definition": "Role-based access control. Also known as role-based security. A permission system to restrict system access based on assigned permissions.",
+ "more": "For more information, see Configuring Users."
+ },
+ "REST user identity": {
+ "definition": "A login to the REST endpoint. Each login is associated with customizable permissions on the cluster and virtual nodes.",
+ "more": ""
+ },
+ "REST worker": {
+ "definition": "A worker that exposes the intranet HTTPS REST control ports of the Corda cluster. The REST workers support all of the dynamic administration APIs of the cluster, such as APIs to configure the cluster, set up user role based permissions, or create and register virtual nodes. ",
+ "more": "REST workers also provide the virtual node endpoint APIs for invoking the flows and the ledger applications, and for retrieving their status/results. All REST calls must be authenticated and authorized, typically using OAUTH2 for login/authentication and Role Based Access Controls checked against a user permissions database. For information about Corda workers, see Workers."
+ },
+ "Revocation check": {
+ "definition": "In the context of X.509 certificates, revocation checks refer to the process of verifying if a digital certificate is still valid and has not been revoked by the issuing Certificate Authority (CA). ",
+ "more": "Revocation checks are typically performed using mechanisms such as Certificate Revocation Lists (CRLs) or the Online Certificate Status Protocol (OCSP), which provide up-to-date information on the revocation status of certificates."
+ },
+ "Sandbox": {
+ "definition": "An execution environment within a JVM process that provides isolation for a CorDapp. It shields it from outside threats but it also restricts what it can do so that running potentially dangerous code cannot harm others.",
+ "more": "While CorDapp writers trust their own code, they can not trust CorDapps written by others, so Corda, as an application hosting platform, treat CorDapps as untrusted code that could be malicious."
+ },
+ "Session identity": {
+ "definition": "Validates the end-to-end connectivity between virtual nodes.",
+ "more": ""
+ },
+ "Session initiation key": {
+ "definition": "The key for a virtual node, which is published in the `MemberInfo`, and used by Link Managers to authenticate and establish secure messaging sessions between network members.",
+ "more": ""
+ },
+ "Session trustroot": {
+ "definition": "The highest-level or root certificate in a certificate chain that is established during a secure communication session. This root certificate is issued by a trusted Certificate Authority (CA) and serves as the ultimate authority for validating the authenticity and trustworthiness of other certificates in the chain. ",
+ "more": "A transport layer security (TLS) communications session established between two endpoints needs to share a common trustroot; this is typically a root certificate authority with a secured private key. By validating the session trust root, an application or user can ensure the integrity and security of the entire certificate chain, leading to the establishment of a secure and encrypted connection between the communicating parties."
+ },
+ "Smart contract": {
+ "definition": "Digitizes agreements by turning the contract terms into code that executes automatically when the terms are met. ",
+ "more": "This means that:Error: Failed to fetch or parse remote JSON from {{ $url }}
+{{ end }} + diff --git a/layouts/partials/referenced-field-desc-ref-docs.html b/layouts/partials/referenced-field-desc-ref-docs.html index 6cc8b3c2564..4ce15429abf 100644 --- a/layouts/partials/referenced-field-desc-ref-docs.html +++ b/layouts/partials/referenced-field-desc-ref-docs.html @@ -1,90 +1,119 @@ -{{/* Called by field-desc-ref-docs or conditional-field-desc-ref-docs to format any config field descriptions defined in another file, referenced from the original file */}} +{{/* +Called by field-desc-ref-docs or conditional-field-desc-ref-docs +to format any config field descriptions defined in another file, referenced from the original file +*/}} + {{ $refurl := .url }} -{{ $refjson := getJSON $refurl }} -{{ $key }} - {{ $value.description}}
- {{ with $value.enum }}
- This must be set to one of the following values:
- {{ $key }} – {{ .description }}
+
+ {{ with .enum }}
+ This must be set to one of the following values:
+ {{ $childk }} - {{ $childv.description}}
- {{ with $childv.enum }}
+
+ {{/* Second-level properties */}}
+ {{ with .properties }}
+ {{ $childk }} – {{ .description }}
+
+ {{ with .enum }}
This must be set to one of the following values:
{{ $childk2 }} - {{ $childv2.description}}
- {{ with $childv2.enum }}
+ {{ end }}
+ {{ $childk2 }} – {{ .description }}
+
+ {{ with .enum }}
This must be set to one of the following values:
Error: Failed to fetch or parse JSON from {{ $refurl }}
{{ $json.description }}
- {{ range $key, $value := $json.properties }} - {{/* Render the details of the value*/}} - {{ with $value }} -{{ $json.description }}
+ + {{ range $key, $value := $json.properties }} + {{ with $value }}Error: Could not load remote JSON from {{ $.Params.url }}
{{ end }} - {{/*Check if there is a conditional set of values at the top level*/}} - {{ with $json.allOf }} - {{ partial "conditional-field-desc-ref-docs" (dict "value" $json "url" $.Params.url) }} - {{ end }} -{{ end }} \ No newline at end of file +{{ else }} +Error: No URL provided to the shortcode.
+{{ end }} + diff --git a/themes/doks/layouts/partials/head/opengraph.html b/themes/doks/layouts/partials/head/opengraph.html index 818f88a8d2d..64269cefcaa 100644 --- a/themes/doks/layouts/partials/head/opengraph.html +++ b/themes/doks/layouts/partials/head/opengraph.html @@ -58,11 +58,11 @@ {{ end -}} {{ if .IsPage -}} - {{ range .Site.Authors -}} + {{ range .Site.Params.Author -}} {{ with .Social.facebook -}} {{ end -}} - {{ with .Site.Social.facebook -}} + {{ with .Site.Params.Social.facebook -}} {{ end -}} @@ -74,6 +74,6 @@ {{ end -}} {{ end -}} -{{ with .Site.Social.facebook_admin -}} +{{ with .Site.Params.Social.facebook_admin -}} {{ end -}} \ No newline at end of file diff --git a/themes/doks/layouts/partials/head/twitter_cards.html b/themes/doks/layouts/partials/head/twitter_cards.html index 884d304ceb5..ca8674ce983 100644 --- a/themes/doks/layouts/partials/head/twitter_cards.html +++ b/themes/doks/layouts/partials/head/twitter_cards.html @@ -18,11 +18,11 @@ -{{ with .Site.Social.twitter -}} +{{ with .Site.Params.Social.twitter -}} {{ end -}} -{{ range .Site.Authors -}} +{{ range .Site.Params.Author -}} {{ with .twitter -}} {{ end -}} diff --git a/themes/doks/layouts/shortcodes/cenmlatestrelref.html b/themes/doks/layouts/shortcodes/cenmlatestrelref.html index 3539150a7d5..4d601e3e643 100644 --- a/themes/doks/layouts/shortcodes/cenmlatestrelref.html +++ b/themes/doks/layouts/shortcodes/cenmlatestrelref.html @@ -1,19 +1,26 @@ {{/* Usage: - {{< cenmlatestrelref "my-page.md" "Link text" "1.2.3" >}} + {{< cenmlatestrelref "cenm/angel-service.md" "Link text" "1.2.3" >}} Arguments: - 0 = target page path (e.g. "my-page.md"), relative to the CEMM version folder. For example, for "content\en\platform\corda\{latest_version}\cenm\angel-service.md, specify "cenm\angel-service.md" - 1 = link text (currently this is NOT optional; in future, will default to title of target page) - 2 = version (optional: defaults to latest version from the cenmversions parameter list) - + 0 = target page path (e.g. "cenm/angel-service" or "cenm/angel-service.md"), relative to the CENM version folder + 1 = link text + 2 = version (optional; defaults to latest from site.Params.cenmversions) */}} - -{{- $target := .Get 0 -}} -{{- $text := .Get 1 -}} +{{- $rawTarget := .Get 0 -}} +{{- $text := .Get 1 -}} {{- $version := .Get 2 | default (replace (index .Site.Params.cenmversions 0) "CENM " "") -}} -{{- $combined := printf "/content/en/platform/corda/%s/%s" $version $target -}} -{{- $rel := $combined | relref . -}} -{{ $text }} \ No newline at end of file +{{/* Normalize path: replace backslashes, strip .md if present */}} +{{- $target := replace $rawTarget "\\" "/" -}} +{{- $target = strings.TrimSuffix ".md" $target -}} + +{{/* Final relative path from content root */}} +{{- $relPath := printf "en/platform/corda/%s/%s" $version $target -}} + +{{- with $rel := $relPath | relref . -}} + {{ $text }} +{{- else -}} + Link not found: {{ $relPath }} +{{- end }} \ No newline at end of file diff --git a/themes/doks/layouts/shortcodes/cordalatestrelref.html b/themes/doks/layouts/shortcodes/cordalatestrelref.html index 8f9cabf4b85..c2f6bfc0f3b 100644 --- a/themes/doks/layouts/shortcodes/cordalatestrelref.html +++ b/themes/doks/layouts/shortcodes/cordalatestrelref.html @@ -1,19 +1,26 @@ {{/* Usage: - {{< cordalatestrelref "my-page.md" "Link text" "1.2.3" >}} + {{< cordalatestrelref "enterprise/notary/db-guidelines.md" "Link text" "1.2.3" >}} Arguments: - 0 = target page path (e.g. "my-page.md"), relative to the Corda version folder. For example, for "content/en/platform/corda/{latest_version}/enterprise/notary/db-guidelines.md", specify "enterprise/notary/db-guidelines.md" - 1 = link text (currently this is NOT optional; in future, will default to title of target page) - 2 = version (optional: defaults to latest version from the corda4versions parameter list) - + 0 = target page path (e.g. "enterprise/notary/db-guidelines.md" or without `.md`), relative to the Corda version folder + 1 = link text (currently required; could be enhanced to default to page title) + 2 = version (optional; defaults to latest from site.Params.corda4versions) */}} - -{{- $target := .Get 0 -}} -{{- $text := .Get 1 -}} +{{- $rawTarget := .Get 0 -}} +{{- $text := .Get 1 -}} {{- $version := .Get 2 | default (replace (index .Site.Params.corda4versions 0) "Corda " "") -}} -{{- $combined := printf "/content/en/platform/corda/%s/%s" $version $target -}} -{{- $rel := $combined | relref . -}} -{{ $text }} +{{/* Normalize path separators and strip .md suffix */}} +{{- $target := replace $rawTarget "\\" "/" -}} +{{- $target = strings.TrimSuffix ".md" $target -}} + +{{/* Construct relative path from content root without /content prefix and without .md */}} +{{- $relPath := printf "en/platform/corda/%s/%s" $version $target -}} + +{{- with $rel := $relPath | relref . -}} + {{ $text }} +{{- else -}} + Link not found: {{ $relPath }} +{{- end }} \ No newline at end of file diff --git a/themes/doks/layouts/shortcodes/glossary.html b/themes/doks/layouts/shortcodes/glossary.html index 44b2f7fb820..8cd7780fb40 100644 --- a/themes/doks/layouts/shortcodes/glossary.html +++ b/themes/doks/layouts/shortcodes/glossary.html @@ -1,16 +1,34 @@ -{{/* Displays the full list of terms and definitions defined for Corda 5 in glossaryitems.json. */}} -{{/*The "definition" field in glossaryitems.json should only be one sentence. This is the text displayed as the ToolTip throughout the content and also displayed by default on the Glossary page.*/}} -{{/*The "more" field in glossaryitems.json displays any additional content displayed by expanding the paragraph on the Glossary page.*/}} +{{/* +Displays the full list of terms and definitions defined for Corda 5 in glossaryitems.json. + +The "definition" field should be a one-sentence tooltip shown throughout content and on the Glossary page. +The "more" field adds extra expandable content on the Glossary page. +*/}} {{ $versionfolder := replace (lower (.Page.Params.version)) " " "/" }} -{{ $file := printf "%s" "/glossaryitems.json" | printf "%s%s" $versionfolder | printf "%s%s" "content/en/platform/" }} -{{ $glossarylist := getJSON $file }} - {{ range $term, $value := $glossarylist }} - {{ $termkebab := lower (replace $term " " "-") }} +{{ $filepath := printf "en/platform/%s/glossaryitems.json" $versionfolder }} + +{{ with resources.Get $filepath }} + {{ $glossarylist := . | transform.Unmarshal }} + + {{ range $term, $value := $glossarylist }} + {{ $termkebab := lower (replace $term " " "-") }} - {{ with $value.more }} -+
Error: Could not load glossary JSON from {{ $filepath }}.