diff --git a/CONTRIBUTING-gitflow.md b/CONTRIBUTING-gitflow.md index f6ed6fcb..fee7d026 100644 --- a/CONTRIBUTING-gitflow.md +++ b/CONTRIBUTING-gitflow.md @@ -91,5 +91,59 @@ git rebase -i master ``` This will open up a text editor where you can specify which commits to squash. +## Instructions on How to Sign Off Commits to Meet the Developer Certificate of Origin (DCO) Requirements + +Contributors to this project are required to sign off on their commits to comply with the Developer Certificate of Origin (DCO). The DCO is a simple statement that you, as the contributor, have the legal right to make the contribution. + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file. + +(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me. + +(c) The contribution was provided directly to me by some other person who certified (a), (b) and I have not modified it. + +(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. + +**How to Sign Off on Your Commits** + +To add the required sign-off to your commits, follow these steps: + +1. Ensure Git is Configured with Your Name and Email + + Your Git configuration must have your correct name and email address, as they will be used to generate the sign-off message. To configure Git, run the following commands: +``` +git config --global user.name "Your Name" +git config --global user.email "your.email@example.com" +``` +2. Use the -s or --signoff Option in Your Commit + + When making a commit, you must use the -s or --signoff option to add the sign-off line. This will append the following line to your commit message: +``` +Signed-off-by: Your Name +``` +Example of a signed-off commit: +``` +git commit -s -m "Fixing issue with Meshery module" +``` + +This ensures that your contribution complies with the DCO. + +3. Verify Your Sign-Off + + To verify that your commit has the sign-off, you can inspect your commit log: +``` +git log -1 +``` +The last commit should contain a Signed-off-by line that matches your name and email. + +4. Amending a Commit Without Sign-Off + + If you've already made a commit but forgot to sign off, you can amend the commit with the sign-off using the following command: +``` +git commit --amend --signoff +``` +This will add the sign-off to your previous commit. + ## Submitting Once you've committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update. diff --git a/README.md b/README.md index c10e0837..b88dc8d8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Layer5 Product Documentation +![image](https://github.com/user-attachments/assets/926e71c4-4f1b-4188-8540-6f951c173710)# Layer5 Product Documentation Explore tutorials and documentation by product in the docs.layer5.io website; documentation and developer resources of Layer5 products. @@ -197,15 +197,15 @@ Find out more on the Layer5 community. Shows an illustrated light mode meshery logo in light color mode and a dark mode meshery logo dark color mode. - -Layer5 Community - +
+Layer5 Community

✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.
-✔️Explore more in the Community Handbook.
+✔️ Explore more in the Community Handbook.

+

Not sure where to start? Grab an open issue with the help-wanted label.

diff --git a/build/meshery-cloud.version b/build/meshery-cloud.version index fee5b027..986c1fe4 100644 --- a/build/meshery-cloud.version +++ b/build/meshery-cloud.version @@ -1 +1 @@ -v0.8.24 +v0.8.34 diff --git a/build/meshery-extensions.version b/build/meshery-extensions.version index e057aa11..762fe493 100644 --- a/build/meshery-extensions.version +++ b/build/meshery-extensions.version @@ -1 +1 @@ -v0.7.117-2 +v0.7.124-2 diff --git a/content/en/cloud/reference/releases/v0.8.25.md b/content/en/cloud/reference/releases/v0.8.25.md new file mode 100644 index 00000000..69239052 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.25.md @@ -0,0 +1,16 @@ +--- +title: v0.8.25 +date: 2024-10-07T19:42:34Z +tag: v0.8.25 +prerelease: false +--- + +## What's New +**General** +- Update capabilities and account extensions and Kanvas icon @leecalcote (#2819) + +## Contributors + +Thank you to our contributors for making this release possible: +@MUzairS15, @l5io and @leecalcote + diff --git a/content/en/cloud/reference/releases/v0.8.26.md b/content/en/cloud/reference/releases/v0.8.26.md new file mode 100644 index 00000000..0e61bab9 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.26.md @@ -0,0 +1,19 @@ +--- +title: v0.8.26 +date: 2024-10-08T21:31:05Z +tag: v0.8.26 +prerelease: false +--- + +## What's New +**General** +- [Sitemap] Combining sitemap exclude with robots.txt allow @leecalcote (#2823) +- Exclude few path from sitemap @sudhanshutech (#2821) +- fix sitemap generation using postbuild process @sudhanshutech (#2808) +- Upgrade kanvas snapshot action version @Aijeyomah (#2820) + +## Contributors + +Thank you to our contributors for making this release possible: +@Aijeyomah, @MUzairS15, @l5io, @leecalcote and @sudhanshutech + diff --git a/content/en/cloud/reference/releases/v0.8.27.md b/content/en/cloud/reference/releases/v0.8.27.md new file mode 100644 index 00000000..b3992991 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.27.md @@ -0,0 +1,11 @@ +--- +title: v0.8.27 +date: 2024-10-12T18:58:51Z +tag: v0.8.27 +prerelease: false +--- + +## What's New +## 🔤 General +- Use sistent filp card in catalog @amitamrutiya (#2827) +- [Chore] Making references to \Meshery Catalog\ just \ No newline at end of file diff --git a/content/en/cloud/reference/releases/v0.8.28.md b/content/en/cloud/reference/releases/v0.8.28.md new file mode 100644 index 00000000..b7176d66 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.28.md @@ -0,0 +1,24 @@ +--- +title: v0.8.28 +date: 2024-10-12T19:31:09Z +tag: v0.8.28 +prerelease: false +--- + +## What's New +## 🔤 General +- switch user-access-cloud -> user-access make account @vishalvivekm (#2835) + +## 🖥 Cloud UI + +- [Public User Profile] Fix reference to Catalog-Card component @leecalcote (#2834) + +## 💻 Server + +- [Public User Profile] Fix reference to Catalog-Card component @leecalcote (#2834) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@l5io, @leecalcote and @vishalvivekm + diff --git a/content/en/cloud/reference/releases/v0.8.29.md b/content/en/cloud/reference/releases/v0.8.29.md new file mode 100644 index 00000000..1ac85680 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.29.md @@ -0,0 +1,16 @@ +--- +title: v0.8.29 +date: 2024-10-13T17:39:59Z +tag: v0.8.29 +prerelease: false +--- + +## What's New +## 🔤 General +* Remove disallow in robots.txt + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@l5io and @leecalcote + diff --git a/content/en/cloud/reference/releases/v0.8.30.md b/content/en/cloud/reference/releases/v0.8.30.md new file mode 100644 index 00000000..a991a9e6 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.30.md @@ -0,0 +1,22 @@ +--- +title: v0.8.30 +date: 2024-10-13T18:07:18Z +tag: v0.8.30 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖥 Cloud UI + +- explicit listing @leecalcote (#2836) + +## 💻 Server + +- explicit listing @leecalcote (#2836) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@l5io and @leecalcote + diff --git a/content/en/cloud/reference/releases/v0.8.31.md b/content/en/cloud/reference/releases/v0.8.31.md new file mode 100644 index 00000000..6a6d99a8 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.31.md @@ -0,0 +1,32 @@ +--- +title: v0.8.31 +date: 2024-10-15T17:51:09Z +tag: v0.8.31 +prerelease: false +--- + +## What's New +## 🔤 General +- Convert catalog filter menu sistent filter @amitamrutiya (#2824) +- Keda design challenge @Alero-Awani (#2829) + +## 🖥 Cloud UI + +- Bump sistent version and make changes based on new sistent version @amitamrutiya (#2844) +- use catalog search field and sort menu to sistent @amitamrutiya (#2825) +- Use cloud hamburger menu into a reusabel sistent component @amitamrutiya (#2822) + +## 🧰 Maintenance + +- ci: remove redundancy label workflow and fix label server @jerensl (#2843) +- fix: change to master branch @jerensl (#2842) +- fix: change input number to input string @jerensl (#2841) +- Fix/dispatch cloud build on pr @jerensl (#2840) +- fix: change token @jerensl (#2839) +- ci: add build cloud ui dispatch @jerensl (#2837) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@Alero-Awani, @MUzairS15, @amitamrutiya, @jerensl, @l5io and @leecalcote + diff --git a/content/en/cloud/reference/releases/v0.8.32.md b/content/en/cloud/reference/releases/v0.8.32.md new file mode 100644 index 00000000..40e99d3f --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.32.md @@ -0,0 +1,18 @@ +--- +title: v0.8.32 +date: 2024-10-16T02:11:05Z +tag: v0.8.32 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖥 Cloud UI + +- [bugfix] Support Menu: Cloud Docs and API Docs links @leecalcote (#2845) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@MUzairS15, @l5io and @leecalcote + diff --git a/content/en/cloud/reference/releases/v0.8.33.md b/content/en/cloud/reference/releases/v0.8.33.md new file mode 100644 index 00000000..e8f096a3 --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.33.md @@ -0,0 +1,20 @@ +--- +title: v0.8.33 +date: 2024-10-16T02:31:17Z +tag: v0.8.33 +prerelease: false +--- + +## What's New +## 🔤 General +- Bump golang.org/x/text from 0.17.0 to 0.18.0 @dependabot (#2804) + +## 🖥 Cloud UI + +- renaming in progress @vishalvivekm (#2818) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@dependabot, @l5io, @leecalcote and @vishalvivekm + diff --git a/content/en/cloud/reference/releases/v0.8.34.md b/content/en/cloud/reference/releases/v0.8.34.md new file mode 100644 index 00000000..121a2eae --- /dev/null +++ b/content/en/cloud/reference/releases/v0.8.34.md @@ -0,0 +1,30 @@ +--- +title: v0.8.34 +date: 2024-10-18T15:25:46Z +tag: v0.8.34 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖥 Cloud UI + +- Complete rtk migration @sudhanshutech (#2791) +- margin fix in dashboard @sudhanshutech (#2849) +- fix header of support page @sudhanshutech (#2848) +- Fix cards not showing in the desing profile tab @amitamrutiya (#2847) + +## ☁️ Api Specifications + +- Refactor service mesh performance tags in schema.yml @leecalcote (#2850) +- Complete rtk migration @sudhanshutech (#2791) + +## 🐛 Bug Fixes + +- Fix cards not showing in the desing profile tab @amitamrutiya (#2847) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@MUzairS15, @amitamrutiya, @l5io, @leecalcote and @sudhanshutech + diff --git a/content/en/kanvas/designer/comments/_index.md b/content/en/kanvas/designer/comments/_index.md index 66dc37c5..dc97741e 100644 --- a/content/en/kanvas/designer/comments/_index.md +++ b/content/en/kanvas/designer/comments/_index.md @@ -91,7 +91,6 @@ Customize your notification preferences to mute email notifications for comments - You'll never miss an important mention, as notifications for mentions outside the muted thread remain active. {{< /alert >}} - ## Best Practices for Effective Design Reviews ### Be specific and actionable diff --git a/content/en/kanvas/designer/understandingr-tool-modes/_index.md b/content/en/kanvas/designer/understandingr-tool-modes/_index.md new file mode 100644 index 00000000..05bf5a46 --- /dev/null +++ b/content/en/kanvas/designer/understandingr-tool-modes/_index.md @@ -0,0 +1,162 @@ +--- +title: Understanding Tool Modes +description: > + Kanvas Designer offers three modes: Default, Pencil, and Connector, which behave differently based on the context in which they are used. Learn how to interact with components and the canvas in each mode. +weight: 7 +categories: [Designer] +tags: [designs] +aliases: +--- +# Tool Modes + +You can switch between mouse modes using hotkeys or tool selection. Here are hotkeys that control your mode: + +**Spacebar**: Temporarily enables the alternative mouse mode (default mode vs pan mode) +**Escape**: Switches to default mode irrespective of which mode you are currently using. + +## Interacting with Components + +### Default Mode (no tool selected) + +**Hover**: Displays subtle indication of focus by outlining the component with a light green color. + Cursor style: “default (arrow)” +**Click-and-drag:** Moves component in the direction of the mouse. + Cursor style: “move” +**Click**: Displays the component toolbar, resize box, and connections handles. + + + +**Double-click**: + +- Components \- Opens the component configurator. + + +Cursor style: “pointer” + +- Textbox \- Enables text editing inside the component. + + +Cursor style: “text” + +**Right-click**: Opens the circular component context menu. + + +## Interacting with the Canvas + +### Default Mode (no tool selected) + +**Hover:** Nothing +Cursor style: “default (arrow)” +**Click**: Nothing +Cursor style: “default (arrow)” +**Double-click**: Opens the quick component configurator. + + + +Cursor style: “pointer” + +**Right-click**: Opens design context menu + + + +Cursor style: “default (arrow)”, with “pointer” on hover of a menu item. + +**Click-and-hold:** Initiates box selection for selecting of multiple components. + + +Cursor style: “crosshair” +**Scroll wheel**: Pan up or down in the direction of the mouse. + + + +Cursor style: “grabbing-hand” + +**Scroll wheel \+ CMD/CTL**: Zoom in/out in the direction of the mouse. +Cursor style: “grabbing-hand” + +**Horizontal scroll wheel**: Pan left or right in the direction of the mouse. +Cursor style: “grabbing-hand” + +#### Pencil Mouse Mode + +Pencil lines do not connect individual components, but offer annotating capability, allowing you to take notes and draw annotations to enhance your designs. +**Hover:** Nothing +Cursor style: “custom(pencil)” +**Mouse down and drag:** Start drawing a freeform line. + + + +Cursor style: “custom(pencil)” +**Mouse down \+ SHIFT:** Start drawing a straight line in the direction of the mouse, which will initiate and remain as either a vertical or horizontal line. + Cursor style: “custom(pencil)” +**Mouse up**: Complete the line and renders into a component with full styling capabilities. + Cursor style: “custom(pencil)” +**Click**: Draws ink from the pencil. + Cursor style: “custom(pencil)” +**Scroll wheel**: Nothing + Cursor style: “custom(pencil)” +**Scroll wheel \+ CMD/CTL**: Nothing + Cursor style: “custom(pencil)” + + + +#### Connector Tool Mode + +The Connector tool operates as a creator of annotation relationships. Note that the connector tool has two behaviors depending upon the context in which you initiate the connection. + +{{< alert title="Connector Behaviors">}} +**Component-connect Behavior**: When you click an empty spot on the canvas, and drag to another empty spot on the canvas, you get a **joint** (aka a terminal node) from which you can create new connections as well as new edge relationships. + +**Canvas-connect Behavior**: When you click an empty spot on the canvas, and drag to an existing component, you get an annotation edge relationship. + +{{< /alert >}} + +**Component-connect Behavior**: When you click an empty spot on the canvas, and drag to another empty spot on the canvas, you get a **joint** (aka a terminal node) from which you can create new connections as well as new edge relationships. + +**Canvas-connect Behavior**: When you click an empty spot on the canvas, and drag to an existing component, you get an annotation edge relationship. + +**Hover:** Nothing + + + +Cursor style: “connector (pen)” (*might* change in the future) + +**Mouse down and drag:** Nothing + +Creating connections happens in three phases. + +1. **Click** (press primary mouse button and release)**:** Initiate connection. + + + +Cursor style: “connector (pen)” +1. **Click and move:** if a connection was initiated, moves the ghost edge around else does nothing. + + + +Cursor style: “connector (pen)” and the annotation edge following the mouse around. +1. **Click while connecting**: Establish and render connection. + + + +Cursor style: “connector (pen)” + + + +#### Pan Mouse Mode + + **Hover:** Nothing + Cursor style: “hand” +**Click-and-hold:** Grab the canvas and pan in the direction of mouse movement. +Cursor style: “grabbing-hand” +**Scroll wheel \+ CMD/CTL**: Zoom in/out in the direction of the mouse. +Cursor style: “grabbing-hand” +**Horizontal scroll wheel**: Pan left or right in the direction of the mouse. +Cursor style: “grabbing-hand” diff --git a/content/en/kanvas/designer/understandingr-tool-modes/tool-mode-placeholder.svg b/content/en/kanvas/designer/understandingr-tool-modes/tool-mode-placeholder.svg new file mode 100644 index 00000000..608f103d --- /dev/null +++ b/content/en/kanvas/designer/understandingr-tool-modes/tool-mode-placeholder.svg @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/en/kanvas/getting-started/images/undeploying-designs/undeploy.png b/content/en/kanvas/getting-started/images/undeploying-designs/undeploy.png new file mode 100644 index 00000000..68010633 Binary files /dev/null and b/content/en/kanvas/getting-started/images/undeploying-designs/undeploy.png differ diff --git a/content/en/kanvas/getting-started/images/validating-designs/performing-validation.png b/content/en/kanvas/getting-started/images/validating-designs/performing-validation.png new file mode 100644 index 00000000..e23bb6c0 Binary files /dev/null and b/content/en/kanvas/getting-started/images/validating-designs/performing-validation.png differ diff --git a/content/en/kanvas/getting-started/images/validating-designs/successful-validation.png b/content/en/kanvas/getting-started/images/validating-designs/successful-validation.png new file mode 100644 index 00000000..8207a6b4 Binary files /dev/null and b/content/en/kanvas/getting-started/images/validating-designs/successful-validation.png differ diff --git a/content/en/kanvas/getting-started/images/validating-designs/validation-error.png b/content/en/kanvas/getting-started/images/validating-designs/validation-error.png new file mode 100644 index 00000000..5f202978 Binary files /dev/null and b/content/en/kanvas/getting-started/images/validating-designs/validation-error.png differ diff --git a/content/en/kanvas/getting-started/images/working-with-components/configuration-panel.png b/content/en/kanvas/getting-started/images/working-with-components/configuration-panel.png new file mode 100644 index 00000000..b19e2959 Binary files /dev/null and b/content/en/kanvas/getting-started/images/working-with-components/configuration-panel.png differ diff --git a/content/en/kanvas/getting-started/images/working-with-components/copy-paste.png b/content/en/kanvas/getting-started/images/working-with-components/copy-paste.png new file mode 100644 index 00000000..84251209 Binary files /dev/null and b/content/en/kanvas/getting-started/images/working-with-components/copy-paste.png differ diff --git a/content/en/kanvas/getting-started/images/working-with-components/radial-menu.png b/content/en/kanvas/getting-started/images/working-with-components/radial-menu.png new file mode 100644 index 00000000..2b0b5249 Binary files /dev/null and b/content/en/kanvas/getting-started/images/working-with-components/radial-menu.png differ diff --git a/content/en/kanvas/getting-started/working-with-components.md b/content/en/kanvas/getting-started/working-with-components.md index f2457cf0..a37dcdd2 100644 --- a/content/en/kanvas/getting-started/working-with-components.md +++ b/content/en/kanvas/getting-started/working-with-components.md @@ -9,6 +9,72 @@ aliases: - /meshmap/getting-started/working-with-components --- +## Configuring Components + +Once you’ve added components to your design in Kanvas, configuring them is a critical step in customizing and optimizing your cloud-native infrastructure. Configuring components allows you to fine-tune their behavior, set specific parameters, and ensure they meet the precise needs of your architecture. + +![configuration-panel](/kanvas/getting-started/images/working-with-components/configuration-panel.png) + +**Steps to Configure Components:** + +1. **Select the Component:** Click on the component on the Kanvas canvas that you want to configure. This action opens the Configuration Panel. + +2. **Adjust Component Settings:** In the Configuration Panel, you can modify various settings, such as resource limits, environment variables, replicas, and more, depending on the type of component you’re working with (e.g., microservices, databases). + +3. **Real-time Updates:** As you adjust configurations, Kanvas will reflect those changes in real-time, allowing you to visualize how the changes affect your overall design. This feature ensures that the design is always up-to-date with the latest configurations. + +By configuring components effectively, you ensure that your cloud-native deployments run smoothly and efficiently, tailored to your specific use case. + +## Using the Radial Context Menu to Lock, Style, Duplicate, and Delete Components + +Kanvas' **radial context menu** provides an intuitive way to interact with components on your design canvas. This menu allows you to quickly perform key actions such as locking, styling, duplicating, and deleting components without leaving the design canvas. + +### Key Functions of the Radial Context Menu: + +1. **Locking Components:** Locking a component ensures it stays fixed in its position on the canvas. This feature is useful when you want to prevent accidental movement of important components during collaboration or further editing. To lock a component, right-click on it to open the radial menu and select the “Lock” option. + + **Use Case:** Locking is helpful when finalizing the design layout, ensuring key components remain in place even when other collaborators make adjustments. + +2. **Styling Components:** The styling option allows you to modify the appearance of the component, such as changing its color or label. This feature is especially useful for visually organizing components, making it easier to distinguish between different types or states within the architecture. + + **Use Case:** Style components to represent various application states, environments (production vs. development), or priority levels in your infrastructure design. + +![radial-menu](/kanvas/getting-started/images/working-with-components/radial-menu.png) + +3. **Duplicating Components:** The radial menu also provides a quick way to duplicate a component. This feature is beneficial when you need multiple instances of the same component with identical configurations. + + **Use Case:** Quickly create replicas of services or microservices with consistent settings without having to reconfigure each one manually. + +4. **Deleting Components:** Removing components is as simple as selecting the “Delete” option from the radial menu. This action helps keep the design clean and organized by removing unnecessary or outdated components. + + **Use Case:** Delete components when modifying or refactoring your design to remove legacy infrastructure or redundant elements. + +The radial context menu offers an efficient, user-friendly way to manage components within Kanvas, streamlining the design process. + +## Annotations + +Annotations in MeshMap are a powerful feature that enables you to add contextual information to your designs directly on the canvas. These annotations can take the form of comments, labels, or freehand drawings, allowing for more detailed communication and documentation throughout the design process. + +### Types of Annotations: + +1. **Text Annotations:** Text annotations allow you to add notes or explanations alongside components. This is useful for providing instructions, detailing configurations, or documenting key decisions made during the design process. + + **Use Case:** Leave detailed instructions for collaborators about specific components or workflows within the design. Annotations are especially helpful when multiple team members are working on a project. + +2. **Pencil and Pen Tool:** The whiteboard feature in MeshMap allows you to use freehand drawings to annotate the design. This is useful for highlighting connections between components, drawing attention to specific areas, or visually brainstorming ideas on the canvas. + + **Use Case:** Use freehand annotations to draw attention to critical connections between services or infrastructure components, or to mark areas that require further review or adjustment. + +3. **Pinning Comments to Components:** In addition to standalone annotations, you can pin comments directly to specific components. This ensures that feedback or instructions remain attached to the component, even if the design evolves or components are moved around. + + **Use Case:** Pin a comment to a database component explaining the configuration and deployment strategy so that future collaborators can easily understand the logic behind it. + +### Importance of Annotations: + +Annotations play a crucial role in collaborative design processes. They provide a way to document decisions, share knowledge, and offer feedback directly within the design environment. This minimizes miscommunication and ensures all team members are aligned on the design's intent and structure. + +By effectively using annotations, you enhance the clarity and transparency of your designs, ensuring that they are well-documented and easy for all collaborators to understand. + ## Copy and Paste Components You can copy and paste one or more components — even if you're going from one design to another. @@ -17,6 +83,7 @@ You can copy and paste one or more components — even if you're going from one You might be able to copy and paste with the right-click menu, but for security reasons, most browsers don't allow web apps (like Kanvas) to use your computer's clipboard through menus. +![copy-paste](/kanvas/getting-started/images/working-with-components/copy-paste.png) To copy and paste, you can use keyboard shortcuts: diff --git a/content/en/kanvas/reference/releases/v0.7.118-1.md b/content/en/kanvas/reference/releases/v0.7.118-1.md new file mode 100644 index 00000000..5e2ac0a8 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.118-1.md @@ -0,0 +1,8 @@ +--- +title: v0.7.118-1 +date: 2024-10-07T19:44:58Z +tag: v0.7.118-1 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.119-1.md b/content/en/kanvas/reference/releases/v0.7.119-1.md new file mode 100644 index 00000000..7baab779 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.119-1.md @@ -0,0 +1,8 @@ +--- +title: v0.7.119-1 +date: 2024-10-07T21:01:17Z +tag: v0.7.119-1 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.119-2.md b/content/en/kanvas/reference/releases/v0.7.119-2.md new file mode 100644 index 00000000..c63665cc --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.119-2.md @@ -0,0 +1,8 @@ +--- +title: v0.7.119-2 +date: 2024-10-07T21:24:53Z +tag: v0.7.119-2 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.119-3.md b/content/en/kanvas/reference/releases/v0.7.119-3.md new file mode 100644 index 00000000..37501d15 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.119-3.md @@ -0,0 +1,8 @@ +--- +title: v0.7.119-3 +date: 2024-10-07T22:40:51Z +tag: v0.7.119-3 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.119-4.md b/content/en/kanvas/reference/releases/v0.7.119-4.md new file mode 100644 index 00000000..449a448e --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.119-4.md @@ -0,0 +1,16 @@ +--- +title: v0.7.119-4 +date: 2024-10-07T23:09:42Z +tag: v0.7.119-4 +prerelease: false +--- + +## What's New +## 🔤 General +* Manually built and packaged graphql plugin. + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@leecalcote + diff --git a/content/en/kanvas/reference/releases/v0.7.120-1.md b/content/en/kanvas/reference/releases/v0.7.120-1.md new file mode 100644 index 00000000..a37cf4d2 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.120-1.md @@ -0,0 +1,8 @@ +--- +title: v0.7.120-1 +date: 2024-10-08T19:01:05Z +tag: v0.7.120-1 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-1.md b/content/en/kanvas/reference/releases/v0.7.121-1.md new file mode 100644 index 00000000..7a044d7c --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-1.md @@ -0,0 +1,8 @@ +--- +title: v0.7.121-1 +date: 2024-10-08T21:12:33Z +tag: v0.7.121-1 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-2.md b/content/en/kanvas/reference/releases/v0.7.121-2.md new file mode 100644 index 00000000..85ed8d25 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-2.md @@ -0,0 +1,8 @@ +--- +title: v0.7.121-2 +date: 2024-10-10T09:11:44Z +tag: v0.7.121-2 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-3.md b/content/en/kanvas/reference/releases/v0.7.121-3.md new file mode 100644 index 00000000..7e60fa0a --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-3.md @@ -0,0 +1,8 @@ +--- +title: v0.7.121-3 +date: 2024-10-11T03:15:32Z +tag: v0.7.121-3 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-4.md b/content/en/kanvas/reference/releases/v0.7.121-4.md new file mode 100644 index 00000000..f3c1ff3b --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-4.md @@ -0,0 +1,8 @@ +--- +title: v0.7.121-4 +date: 2024-10-11T13:13:21Z +tag: v0.7.121-4 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-5.md b/content/en/kanvas/reference/releases/v0.7.121-5.md new file mode 100644 index 00000000..0d0b7c36 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-5.md @@ -0,0 +1,8 @@ +--- +title: v0.7.121-5 +date: 2024-10-11T15:21:25Z +tag: v0.7.121-5 +prerelease: false +--- + + diff --git a/content/en/kanvas/reference/releases/v0.7.121-6.md b/content/en/kanvas/reference/releases/v0.7.121-6.md new file mode 100644 index 00000000..9211399e --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-6.md @@ -0,0 +1,27 @@ +--- +title: v0.7.121-6 +date: 2024-10-13T08:41:30Z +tag: v0.7.121-6 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Kanvas + +- Add hotkey for textbox and comment @amitamrutiya (#2938) +- fix: pen mode not exiting on clicking icon on dock @aabidsofi19 (#2979) +- Add new hotkeys @aabidsofi19 (#2978) + +## 🧰 Maintenance + +- ci: fix release notes multiline @jerensl (#2983) +- ci: change a template a bit @jerensl (#2982) +- Ci/update release label @jerensl (#2981) +- ci: update release label @jerensl (#2980) +- ci: add release notes body @jerensl (#2977) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@Yashsharma1911, @aabidsofi19, @amitamrutiya, @jerensl, @l5io and @leecalcote diff --git a/content/en/kanvas/reference/releases/v0.7.121-7.md b/content/en/kanvas/reference/releases/v0.7.121-7.md new file mode 100644 index 00000000..35b3c880 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.121-7.md @@ -0,0 +1,28 @@ +--- +title: v0.7.121-7 +date: 2024-10-15T07:35:45Z +tag: v0.7.121-7 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Kanvas + +- ci: add logical and for label kanvas @jerensl (#2990) +- fix: labels and annotations not expanding by default @aabidsofi19 (#2988) +- fix: double border stroke not legible in pamela @aabidsofi19 (#2987) +- [Enhance] Mode Switcher: New Visualizer mode name and icon @leecalcote (#2986) +- [Enhancement] Distinct arrowhead icon for annotation arrows @leecalcote (#2985) +- fix border width value always zero in pamela @aabidsofi19 (#2984) + +## 🧰 Maintenance + +- ci: disable auto label from release draft @jerensl (#2991) +- ci: add logical and for label kanvas @jerensl (#2990) +- Ci/chore auto labeler @jerensl (#2989) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@aabidsofi19, @jerensl, @l5io and @leecalcote diff --git a/content/en/kanvas/reference/releases/v0.7.122-1.md b/content/en/kanvas/reference/releases/v0.7.122-1.md new file mode 100644 index 00000000..d2d436e7 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.122-1.md @@ -0,0 +1,35 @@ +--- +title: v0.7.122-1 +date: 2024-10-15T19:56:44Z +tag: v0.7.122-1 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Designer + +- [Modals] Enhance one of kanvas.new modals for self-hosting @leecalcote (#3003) +- fix height and width of the quick tip modal @amitamrutiya (#2997) +- update new empty kanvas svgs @amitamrutiya (#2996) +- build(deps-dev): bump eslint-plugin-react from 7.33.2 to 7.37.1 in /meshmap @dependabot (#2993) +- build(deps-dev): bump css-loader from 6.8.1 to 7.1.2 in /meshmap @dependabot (#2994) + +## 🐛 Bug Fixes + +- fix height and width of the quick tip modal @amitamrutiya (#2997) + +## 🧰 Maintenance + +- [CI] Add Checkout Repo @leecalcote (#3002) +- [CI] Enhance to use full base+extension versioning (Attempt #2) @leecalcote (#3001) +- [CI] Enhance to use full base+extension versioning @leecalcote (#3000) +- add extension version logic to release drafter w/singoff @Jougan-0 (#2999) +- uncomment go mod code w/singoff @Jougan-0 (#2998) +- build(deps-dev): bump eslint-plugin-react from 7.33.2 to 7.37.1 in /meshmap @dependabot (#2993) +- build(deps-dev): bump css-loader from 6.8.1 to 7.1.2 in /meshmap @dependabot (#2994) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@Jougan-0, @aabidsofi19, @amitamrutiya, @dependabot, @dependabot[bot], @l5io and @leecalcote diff --git a/content/en/kanvas/reference/releases/v0.7.122-2.md b/content/en/kanvas/reference/releases/v0.7.122-2.md new file mode 100644 index 00000000..1d14c375 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.122-2.md @@ -0,0 +1,8 @@ +--- +title: v0.7.122-2 +date: 2024-10-16T02:59:13Z +tag: v0.7.122-2 +prerelease: false +--- + +null diff --git a/content/en/kanvas/reference/releases/v0.7.123-1.md b/content/en/kanvas/reference/releases/v0.7.123-1.md new file mode 100644 index 00000000..b4b2655a --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.123-1.md @@ -0,0 +1,28 @@ +--- +title: v0.7.123-1 +date: 2024-10-17T15:44:34Z +tag: v0.7.123-1 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Designer + +- fix : opacity border width out of sync in pamela @aabidsofi19 (#3008) + +## 🐛 Bug Fixes + +- fix : opacity border width out of sync in pamela @aabidsofi19 (#3008) +- ci: fix release draft @jerensl (#3005) + +## 🧰 Maintenance + +- ci: refactor extensions test pr workflow @jerensl (#3010) +- ci: change the release draft title @jerensl (#3006) +- ci: fix release draft @jerensl (#3005) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@Jougan-0, @aabidsofi19, @jerensl and @l5io diff --git a/content/en/kanvas/reference/releases/v0.7.123-2.md b/content/en/kanvas/reference/releases/v0.7.123-2.md new file mode 100644 index 00000000..ae76926b --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.123-2.md @@ -0,0 +1,18 @@ +--- +title: v0.7.123-2 +date: 2024-10-17T21:16:33Z +tag: v0.7.123-2 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Designer + +- [style fix] user account required modal: Use Sistent Links, not a tags @leecalcote (#3012) +- update the height and width of the quick tip @amitamrutiya (#3009) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@amitamrutiya, @l5io and @leecalcote diff --git a/content/en/kanvas/reference/releases/v0.7.123-3.md b/content/en/kanvas/reference/releases/v0.7.123-3.md new file mode 100644 index 00000000..e34c7956 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.123-3.md @@ -0,0 +1,22 @@ +--- +title: v0.7.123-3 +date: 2024-10-18T11:21:41Z +tag: v0.7.123-3 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Designer + +- fix: tutorial not open issue from shortcut menu @amitamrutiya (#3013) +- Create modal from choose from template in empty kanvas @amitamrutiya (#2995) + +## 🐛 Bug Fixes + +- fix: tutorial not open issue from shortcut menu @amitamrutiya (#3013) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@aabidsofi19, @amitamrutiya, @l5io and @leecalcote diff --git a/content/en/kanvas/reference/releases/v0.7.124-1.md b/content/en/kanvas/reference/releases/v0.7.124-1.md new file mode 100644 index 00000000..221c52f4 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.124-1.md @@ -0,0 +1,15 @@ +--- +title: v0.7.124-1 +date: 2024-10-18T12:38:50Z +tag: v0.7.124-1 +prerelease: false +--- + +## What's New +## 🔤 General +* No changes + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@l5io diff --git a/content/en/kanvas/reference/releases/v0.7.124-2.md b/content/en/kanvas/reference/releases/v0.7.124-2.md new file mode 100644 index 00000000..571fc769 --- /dev/null +++ b/content/en/kanvas/reference/releases/v0.7.124-2.md @@ -0,0 +1,17 @@ +--- +title: v0.7.124-2 +date: 2024-10-18T20:58:09Z +tag: v0.7.124-2 +prerelease: false +--- + +## What's New +## 🔤 General +## 🖌️ Designer + +- [wip]tool mode ux @aabidsofi19 (#3007) + +## 👨🏽‍💻 Contributors + +Thank you to our contributors for making this release possible: +@aabidsofi19, @l5io and @leecalcote diff --git a/content/en/kanvas/tasks/designs/undeploying-designs.md b/content/en/kanvas/tasks/designs/undeploying-designs.md index 10617318..d2b7d3a7 100644 --- a/content/en/kanvas/tasks/designs/undeploying-designs.md +++ b/content/en/kanvas/tasks/designs/undeploying-designs.md @@ -9,9 +9,13 @@ aliases: - /meshmap/tasks/designs/undeploying-designs --- -{{% pageinfo %}} -Page under construction. -{{% /pageinfo %}} +To undeploy the resources + +1. Navigate to the Actions button at the top of the Meshery Design canvas. + +2. Click on the **Undeploy** icon. + +![undeploying designs](/kanvas/getting-started/images/undeploying-designs/undeploy.png)