Skip to content

Commit 781fce3

Browse files
committed
docs: migrate hardcoded Related Docs/See Also blocks to Related Reading
Repo-wide follow-up to PR #1129 (issue #1028), applying the same pattern used for Pinning Models to the Dock / Understanding Tool Modes across the rest of the docs: remove hardcoded "Related Docs"/"See Also"/"Related pages"/"Related" link blocks and inline references, and let the site's taxonomy-driven Related Reading partial surface the same connections via categories/tags instead. Migrated: - videos/getting-started/basics/operator-overview.md (-> kanvas/operator/_index.md) - videos/getting-started/basics/designer-overview.md (-> kanvas/designer/_index.md) - videos/getting-started/comments/design-reviews-full.md (-> kanvas/designer/comments/index.md) - kanvas/operator/log-streaming/index.md <-> interactive-terminal/index.md, advanced/performance/index.md - kanvas/operator/interactive-terminal/index.md <-> log-streaming/index.md - kanvas/advanced/render-modes.md <-> autopan.md, performance/index.md, url-parameters/index.md - kanvas/advanced/autopan.md <-> render-modes.md, performance/index.md, url-parameters/index.md - kanvas/advanced/performance/index.md <-> render-modes.md, autopan.md - cloud/guides/organizations/configuration-scenarios/index.md <-> white-labeling, identity-services, organizations (concept), identity-and-security Front matter changes, only where existing categories/tags didn't already establish the connection: - log-streaming + interactive-terminal: added tags: [troubleshooting] (shared category Operator alone is a 7-way tie that doesn't reliably survive the top-6 cutoff) - operator-overview.md + kanvas/operator/_index.md: added tags: [operator-overview] - designer-overview.md + kanvas/designer/_index.md: added tags: [designer-overview] (uncommented/set; was previously commented out) - configuration-scenarios.md, white-labeling/_index.md, identity-services/index.md, identity-and-security/_index.md: added the existing "orgs" tag where missing, so each shares 2-3 tags with configuration-scenarios rather than relying on the generic Identity category alone (13 pages deep, easily crowded out of the top 6) Depends on the related-reading.html section-page fix in the preceding commit for 5 of these links (kanvas/operator/_index.md, kanvas/designer/_index.md, white-labeling/_index.md, organizations/_index.md, identity-and-security/_index.md are all section pages). Verified: hugo build (1523 pages, no errors) and manual inspection of rendered Related Reading output on every migrated page. Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
1 parent 2100ec9 commit 781fce3

14 files changed

Lines changed: 11 additions & 54 deletions

File tree

content/en/cloud/concepts/identity-and-security/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: >
55
Organizations, teams, users, roles, keychains, keys, sessions, and tokens.
66
weight: 3
77
categories: [Identity, Security]
8-
tags: [permissions, identity, authentication]
8+
tags: [permissions, identity, authentication, orgs]
99
aliases:
1010
- /cloud/identity/
1111
- /cloud/security/

content/en/cloud/guides/organizations/configuration-scenarios/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,3 @@ email-domain allowlists, role and team assignment, quotas, and expiry). Any
194194
scenario above can be paired with any membership policy. See
195195
[Organization Management → Inviting members](/cloud/guides/organizations/org-management/)
196196
and [User Invitations](/cloud/concepts/identity-and-security/users/user-invitations/).
197-
198-
## Related
199-
200-
- [White-labeling (Rebranding)](/cloud/guides/self-hosted/white-labeling/) — themes, logos, custom domains, and the social-sign-in details.
201-
- [Identity Services](/cloud/guides/self-hosted/planning/identity-services/) — BYOC, OIDC single sign-on, and authentication boundaries.
202-
- [Organizations (concept)](/cloud/concepts/identity-and-security/organizations/) — organizations as the unit of multi-tenancy.
203-
- [Identity and Security → Security Boundaries](/cloud/concepts/identity-and-security/#security-boundaries) — how authentication and authorization boundaries compose.

content/en/cloud/guides/self-hosted/planning/identity-services/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Identity Services
33
description: "Understand identity services prerequisites and how to integrate your existing identity with OIDC."
44
categories: [Self-Hosted]
5-
tags: [identity]
5+
tags: [identity, byoc, orgs]
66
weight: 3
77
aliases:
88
- /cloud/self-hosted/planning/identity-services/

content/en/cloud/guides/self-hosted/white-labeling/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: White-labeling (Rebranding)
33
weight: 1
44
categories: [Self-Hosted]
5+
tags: [white-labeling, custom-domain, orgs]
56
description: >
67
Customize the appearance and branding of your engineering platform powered by Layer5 Cloud.
78
aliases:

content/en/kanvas/advanced/autopan.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,3 @@ If autopan is disabled on a design where you would like it to be active, you hav
107107
1. **Switch to a lower-fidelity render mode.** Wireframe and View-Only raise the threshold to 1,000 nodes. See the [Render Modes]({{< ref "kanvas/advanced/render-modes.md" >}}) page for what each mode costs and what it hides.
108108
2. **Reduce the live listener count.** The [Layers Panel]({{< ref "kanvas/advanced/performance/index.md" >}}) lets you disable layers of visual information (badges, tags, feasibility indicators) that contribute to the pan fan-out. Turning off a layer effectively moves the threshold upward because there are fewer listeners to amplify each pan.
109109
3. **Break the design into smaller designs.** If you are consistently bumping the threshold in your preferred render mode, the design might be past the scale Kanvas targets for interactive editing. Splitting it into referenced sub-designs keeps each one within the sweet spot.
110-
111-
### Related pages
112-
113-
- [Render Modes]({{< ref "kanvas/advanced/render-modes.md" >}}) — what each mode renders, what it hides, and how Adaptive Render Mode flips between them automatically.
114-
- [Performance Limits and Tuning]({{< ref "kanvas/advanced/performance/index.md" >}}) — overall Kanvas performance envelope and the Layers Panel.
115-
- [Design Render Quality]({{< ref "kanvas/advanced/url-parameters/index.md" >}}) — overriding the render mode via URL parameters (useful for snapshots and embeds).

content/en/kanvas/advanced/performance/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,6 @@ To optimize performance, consider the following:
103103

104104
As your designs grow in complexity, certain design patterns can impact how smoothly Kanvas responds. Understanding these factors helps you create designs that remain fast and responsive.
105105

106-
{{< alert type="info" title="Related performance controls" >}}
107-
This page covers the design patterns and tuning levers that affect Kanvas performance. For the per-mode rendering ladder (Full, Medium, Wireframe, View-Only) and automatic fidelity management, see [Render Modes]({{< ref "kanvas/advanced/render-modes.md" >}}). For the drag-to-edge viewport pan and its per-render-mode size thresholds, see [Auto-pan on Drag]({{< ref "kanvas/advanced/autopan.md" >}}).
108-
{{< /alert >}}
109-
110106
### Working with Grouped Components
111107

112108
When you create groups of components (placing multiple components inside a parent container), you might notice performance differences as the number of grouped items increases. Here's what you might experience:

content/en/kanvas/advanced/render-modes.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,3 @@ All four render modes work in both Designer and Operator contexts:
231231
- In **Designer mode**, render modes control the fidelity of your editable design canvas. All modes except View Only allow full editing.
232232
- In **Operator mode**, the `managed-by-Meshery` and `terminal session` badges follow the same suppression rules as in Designer — they are visible in Full mode and hidden in Medium, Wireframe, and View Only modes.
233233
- **View Only mode is particularly useful in Operator** for monitoring dashboards where accidental edits should be prevented.
234-
235-
## Related pages
236-
237-
- [Auto-pan on Drag]({{< ref "kanvas/advanced/autopan.md" >}}) — the most visible feature gated per render mode.
238-
- [Performance Limits and Tuning]({{< ref "kanvas/advanced/performance/index.md" >}}) — full performance envelope and the Layers Panel.
239-
- [Design Render Quality]({{< ref "kanvas/advanced/url-parameters/index.md" >}}) — URL parameter overrides for render mode.

content/en/kanvas/designer/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >
44
Designer mode is for those who want to create their own Kanvas, using the palette of components provided by Meshery.
55
weight: 4
66
categories: [Designer]
7-
# tags: [designs]
7+
tags: [designer-overview]
88
aliases:
99
- /meshmap/designer/
1010
---

content/en/kanvas/operator/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ weight: 5
44
description: >
55
Operator mode is for operating your Kubernetes clusters and cloud native infrastructure.
66
categories: [Operator]
7+
tags: [operator-overview]
78
aliases:
89
- /meshmap/operator
910
---

content/en/kanvas/operator/interactive-terminal/index.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Interactive Terminal
33
description: >
44
Learn about Interactive Terminal in Operator mode
55
categories: [Operator]
6+
tags: [troubleshooting]
67
---
78

89
When operating cloud native infrastructure, deep diagnostics often require direct access to the container shell. The **Interactive Terminal** in Kanvas enables you to execute commands and inspect the filesystem of your running containers directly from the visual topology. By integrating terminal sessions into the Kanvas interface, you can troubleshoot issues, verify configurations, and test network connectivity without switching context to external CLI tools like `kubectl`.
@@ -72,10 +73,3 @@ While using the interactive terminal, understand that you can only open one sess
7273
<!-- {{< figure src="images/interactive-terminal-sequence-diagram.svg" link="images/interactive-terminal-sequence-diagram.svg" width="100%" alt="interactive-terminal-sequence-diagram" >}} -->
7374

7475
![interactive-terminal-sequence-diagram](images/interactive-terminal-sequence-diagram.svg)
75-
76-
***
77-
78-
### See Also
79-
80-
* **[Log Streaming]({{< ref "kanvas/operator/log-streaming/index.md" >}}):** Learn how to live-tail logs for real-time application monitoring.
81-
<!-- * **[Performance Management]({{< ref "kanvas/advanced/performance/index.md" >}}):** Run load tests and analyze performance profiles. -->

0 commit comments

Comments
 (0)