Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tags: grouping by key/value pairs #250

Merged
merged 3 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions content/en/meshmap/designer/tagsets/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Working with Tags
description: >
Share design with other users and use control access to manage design access permissions and visibility.
weight: 6
categories: [Designer]
tags: [designs, collaboration, review]
---

## Overview

You can group components using tags. Tags are key-value pairs that help you organize and categorize components within your design. Tags can be used to visually group components. You can also use tags to filter components and view only those that match the tag criteria.

{{< alert title="Related Concept">}}
Kubernetes resources are capable of being assigned Label and Annotation key/value pairs. When pairs of Labels or Annotations match, a relationship is formed and visualized as shown below.
{{< /alert >}}

## Grouping Components with Tags

To group components using tags, follow these steps.

![Tags](./tagsets.gif)

## Labels and Annotations

Designs support two different types of tags: Labels and Annotations. Labels are often used to identify components and are visible on the design canvas. Annotations are often used to provide additional information about components.

<img alt="Labels and Annotations" src="./group-components.png" width="50%" />

{{< alert title="Performance Consideration" type="warning">}}
Tags are indexed and searchable. However, the performance of design operations may degrade as the number of tags increases. To ensure an optimal user experience, we recommend using tags judiciously and limiting the number of tags used in a design.

MeshMap will disable grouping by tags when the number of tags exceeds 10 within a single Design.
{{< /alert >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/meshmap/designer/tagsets/tagsets.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading