Skip to content

Commit

Permalink
Merge branch 'master' into docs/mu5a/244
Browse files Browse the repository at this point in the history
  • Loading branch information
vishalvivekm authored Sep 24, 2024
2 parents 0864a6f + 7153251 commit 5600e92
Show file tree
Hide file tree
Showing 143 changed files with 809 additions and 175 deletions.
10 changes: 6 additions & 4 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

component/cloud-docs:
- changed-files:
- any-glob-to-any-file:
- "content/en/cloud/**/*"

component/meshmap-docs:
- "content/en/meshmap/**/*"
component/kanvas-doc:
- changed-files:
- any-glob-to-any-file:
- "content/en/kanvas/**/*"
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ node_modules/
.vscode/

.DS_Store

latest_release.json
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,19 +75,19 @@ Meshery Workspaces serve as a virtual space for your team-based work.

### Tutorials

- **MeshMap Snapshots**: Connect MeshMap to your GitHub repo and see changes pull request-to-pull request.
- **Kanvas Snapshots**: Connect Kanvas to your GitHub repo and see changes pull request-to-pull request.
- **Sharing a Workspace**: Learn how to control access to workspaces and their resources.
- **Recognizing User and Contributor Milestones**: Showcasing user and contributor achievements

### Self-Hosted

Keep your MeshMap designs internal to your workplace. Get remote support from Layer5 when you need it.
Keep your Kanvas designs internal to your workplace. Get remote support from Layer5 when you need it.

### Reference

Low-level ReST API reference for extending Layer5 Cloud.

## Meshmap Docs
## Kanvas Docs

### Getting Started with Designs

Expand All @@ -98,8 +98,8 @@ Low-level ReST API reference for extending Layer5 Cloud.

### Exploring Designer

- **Reviewing Designs:** Learn how to leverage comments in MeshMap’s Designer Mode to enhance collaboration and streamline design reviews.
- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside meshmap
- **Reviewing Designs:** Learn how to leverage comments in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside kanvas
- **Export Designs:** How to export your designs for backup , sharing or offline use.

### Working with Components
Expand All @@ -112,15 +112,15 @@ Visualizer mode is for operating your Kubernetes clusters and cloud native infra

### Core Tasks

- **Whiteboarding:** MeshMap Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
- **Whiteboarding:** Kanvas Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.

- **Deploying Designs:** Validating Designs, Undeploying Designs, Deploying Designs, Cloning a Design

### Reference

- **Keyboard Shortcuts:** Learn the keyboard shortcuts for Meshmap to enhance your designing experience.
- **Keyboard Shortcuts:** Learn the keyboard shortcuts for Kanvas to enhance your designing experience.

- **Troubleshooting MeshMap:** Learn to Troubleshoot the MeshMap
- **Troubleshooting Kanvas:** Learn to Troubleshoot the Kanvas

### Contribution Guidelines

Expand Down
12 changes: 11 additions & 1 deletion assets/scss/_navbar_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,19 @@
color: $primary !important;
}

@media (min-width: 768px) {
&:hover {
.dropdown-menu {
display: block;
}
.dropdown-menu {
transform: translate(-15%, 0rem);
}
}
}
.dropdown-menu {
padding: 0;
transform: translate(-15%, 2.5rem) !important;
transform: translate(-15%, 2.5rem);
border-radius: 0;
.dropdown-item {
height: 5rem;
Expand Down
8 changes: 4 additions & 4 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ onmouseover="changeImage('layer5', 'images/logos/layer5-light.svg')" onmouseout=
Cloud Docs
<i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="/meshmap" aria-label="MeshMap Docs"
onmouseover="changeImage('Meshmap', 'images/logos/meshmap-light.svg')" onmouseout="restoreImage('Meshmap', 'images/logos/meshmap-alt.svg')">
<img id="Meshmap" src="images/logos/meshmap-alt.svg" alt="Layer5 MeshMap Docs Logo" />
MeshMap Docs
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="/kanvas" aria-label="Kanvas Docs"
onmouseover="changeImage('Kanvas', 'images/logos/kanvas-light.svg')" onmouseout="restoreImage('Kanvas', 'images/logos/kanvas-alt.svg')">
<img id="Kanvas" src="images/logos/kanvas-alt.svg" alt="Layer5 Kanvas Docs Logo" />
Kanvas Docs
<i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="https://docs.meshery.io" aria-label="Meshery Docs"
Expand Down
8 changes: 4 additions & 4 deletions content/en/cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ cascade:
**Meshery** ([docs](https://docs.meshery.io)) is a cloud native manager that enables the design and management of Kubernetes-based infrastructure and applications. It is an extensible developer platform that seamlessly integrates with all CNCF projects, and various monitoring, CI/CD, and security tools.
</div></div>

<div style="display: flex; align-items: flex-start; margin-top:15px;"><div class="logo-container">{{< svg name="meshmap" >}}</div>
<div style="display: flex; align-items: flex-start; margin-top:15px;"><div class="logo-container">{{< svg name="kanvas" >}}</div>

<div style="flex: 1;">

**MeshMap** ([docs](/meshmap)) provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. MeshMap aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
**Kanvas** ([docs](/kanvas)) provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. Kanvas aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
</div></div>
</div>
{{% /pageinfo %}}
Expand All @@ -50,7 +50,7 @@ Please follow this space for updates!
{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}}
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}
{{% blocks/feature icon="./featured-background.png" title="MeshMap" url="/meshmap" %}}
**MeshMap** provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. MeshMap aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
{{% blocks/feature icon="./featured-background.png" title="Kanvas" url="/kanvas" %}}
**Kanvas** provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. Kanvas aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
{{% /blocks/feature %}}
{{< /blocks/section >}} -->
2 changes: 1 addition & 1 deletion content/en/cloud/catalog/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The design catalog can be accessed from the _Layer5 Cloud_ catalog page at [Laye

{{< alert title="Note" >}}

Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. Learn more about [Designs](/meshmap/getting-started/)
Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. Learn more about [Designs](/kanvas/getting-started/)

{{< /alert >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ weight: 2
4. For detailed information just click on it.
5. Simply click the green clone button.
6. Now you have it. Navigate to [Meshery Playground](https://playground.meshery.io/)
7. Go to the MeshMap and you will see your cloned template here. If you con't see it just reload the page.
7. Go to the Kanvas and you will see your cloned template here. If you con't see it just reload the page.

You can also publish your own design as a template.
4 changes: 2 additions & 2 deletions content/en/cloud/getting-started/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can commence the integration process from the "**Extensions Page in Meshery*
### Access Integrations Page from the Meshery Extensions Page

1. Go to [Extensions](https://playground.meshery.io/extensions).
1. Click on **Enable** for **GitHub Action: MeshMap Snapshot**.
1. Click on **Enable** for **GitHub Action: Kanvas Snapshot**.
1. You will be redirected to the Integrations page.

![Extensions](/cloud/getting-started/images/github/extensions.png)
Expand Down Expand Up @@ -128,7 +128,7 @@ These next steps are optional. By enabling snapshots, you can choose a design fr

- **Assigns Permissions**: Provides necessary permissions for reading actions, writing content, handling security events, statuses, and pull requests.

- **Captures Snapshots**: Uses the MeshMap-Snapshot action to capture snapshots of your infrastructure based on the specified application_type (e.g. Kubernetes Manifest, Docker Compose, Helm Chart).
- **Captures Snapshots**: Uses the Kanvas-Snapshot action to capture snapshots of your infrastructure based on the specified application_type (e.g. Kubernetes Manifest, Docker Compose, Helm Chart).

With the workflow active in your repository, you can now visualize changes to your infrastructure directly in your pull requests, making it easier to track and review updates on designs.

Expand Down
26 changes: 13 additions & 13 deletions content/en/cloud/github-actions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,48 @@ title: GitHub Actions
description: GitHub Actions with Meshery automates the synchronization of Git repositories and visually validates pull requests for efficient development.
weight: 20
categories: [Workspaces]
tags: [gitops, github-actions, meshmap]
tags: [gitops, github-actions, kanvas]
---
Meshery GitHub Actions enhance your operational workflow by integrating git version control and the management of your infrastructure. Meshery GitHub Actions are design to integrate into your existing pipelines.

## Meshery Github Actions

1. [MeshMap Snapshot](#meshmap-snapshot-github-action)
1. [Kanvas Snapshot](#kanvas-snapshot-github-action)
2. [Performance Testing with Meshery](https://docs.meshery.io/guides/gitops-with-meshery)
3. Archived: [Service Mesh Interface Conformance with Meshery](https://github.com/marketplace/actions/service-mesh-interface-conformance-with-meshery)

This methodology automates the synchronization of your actual infrastructure state with the desired state defined in your Git repository. Meshery enables GitOps by offering a comprehensive view of your infrastructure, allowing you to verify workload designs and Kubernetes cluster configurations before merging pull requests.

## MeshMap Snapshot GitHub Action
## Kanvas Snapshot GitHub Action

Meshery introduces the MeshMap Snapshot GitHub Actions, a tool that allows you to visualize changes in your infrastructure directly in your pull requests. With MeshMap Snapshot, you can:
Meshery introduces the Kanvas Snapshot GitHub Actions, a tool that allows you to visualize changes in your infrastructure directly in your pull requests. With Kanvas Snapshot, you can:

- See your deployment changes pull request-to-pull request.
- Get snapshots of your infrastructure directly in your pull requests.

[See action in GitHub Marketplace](https://github.com/marketplace/actions/meshmap-snapshot)
[See action in GitHub Marketplace](https://github.com/marketplace/actions/kanvas-snapshot)

### Configuring MeshMap Snapshots
### Configuring Kanvas Snapshots

MeshMap serves as a fundamental component, providing visual insights into infrastructure changes and facilitating the synchronization between the actual and desired states. Ensure that you have proper access to MeshMap to leverage its capabilities for effective GitOps implementation.
Kanvas serves as a fundamental component, providing visual insights into infrastructure changes and facilitating the synchronization between the actual and desired states. Ensure that you have proper access to Kanvas to leverage its capabilities for effective GitOps implementation.

#### Step 1: Get access to MeshMap
#### Step 1: Get access to Kanvas

To integrate Snapshots into your GitHub pull requests, confirm that your user account has MeshMap access. To do so, sign into your Layer5 Cloud account and look forIf your user account doesn't have access, [simply request access](https://meshery.layer5.io/account/subscriptions) to MeshMap.
To integrate Snapshots into your GitHub pull requests, confirm that your user account has Kanvas access. To do so, sign into your Layer5 Cloud account and look forIf your user account doesn't have access, [simply request access](https://meshery.layer5.io/account/subscriptions) to Kanvas.

#### Step 2: Enable MeshMap Snapshot Action
#### Step 2: Enable Kanvas Snapshot Action

1. Choose to enable the MeshMap Snapshot action for all repositories in your GitHub account or for specific repositories.
1. Choose to enable the Kanvas Snapshot action for all repositories in your GitHub account or for specific repositories.
1. Authorize the Meshery GitHub App.
1. Copy the Secret token. This token is used to authenticate Meshery with your Layer5 Cloud account.
1. Once authorized, Meshery will automatically create a pull request workflow for your repository. To disable the workflow, simply delete the `.github/workflows/meshmap-snapshot.yml` file from your repository.
1. Once authorized, Meshery will automatically create a pull request workflow for your repository. To disable the workflow, simply delete the `.github/workflows/kanvas-snapshot.yml` file from your repository.
1. Specify the path within your Git repository where the application configurations are stored. This ensures Meshery knows where to find and visuzlie the desired state of your infrastructure.

{{%pageinfo%}}
The Meshery GitHub App requires authorization to interact with your repositories. If you would like to use your GitHub user's personal access token, instead, [please let us know](https://meshery.layer5.io/support). {{%/pageinfo%}}


## Customizing Snapshot Workflow Triggers in MeshMap Snapshot
## Customizing Snapshot Workflow Triggers in Kanvas Snapshot

You can configure your workflows to run when specific activity on GitHub happens, at a scheduled time, or when an event outside of GitHub occurs.

Expand Down
4 changes: 2 additions & 2 deletions content/en/cloud/identity/users/notification-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Layer5 Cloud offers a range of user-configurable preferences that allows you to

- **Workspace Activity:** You can choose to be notified about:
- Changes to Designs
- Comments on Your Designs: Check this box to receive notifications for all new comments on your designs. Unchecking this box will disable all comment notifications. If you prefer to keep this box checked but wish to stop receiving notifications for a specific comment thread, you can directly mute notifications for that thread in the comment modal. You can [learn more about this feature](https://docs.layer5.io/meshmap/designer/comments/#mute-comment-notifications).
- Comments on Your Designs: Check this box to receive notifications for all new comments on your designs. Unchecking this box will disable all comment notifications. If you prefer to keep this box checked but wish to stop receiving notifications for a specific comment thread, you can directly mute notifications for that thread in the comment modal. You can [learn more about this feature](https://docs.layer5.io/kanvas/designer/comments/#mute-comment-notifications).
- Deployment in environments
- Membership Changes: team membership, user account creation/deletion
- Participating, @mentions in comments: [Learn more](https://docs.layer5.io/meshmap/designer/comments/#mute-comment-notifications)
- Participating, @mentions in comments: [Learn more](https://docs.layer5.io/kanvas/designer/comments/#mute-comment-notifications)
- Weekly summary

5. Click **Save Preferences**
Expand Down
8 changes: 8 additions & 0 deletions content/en/cloud/reference/releases/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Releases
description: Release version of Layer5 Cloud.
weight: 20
categories: [Reference]
tags: [docs]
type: release
---
13 changes: 13 additions & 0 deletions content/en/cloud/reference/releases/v0.8.0-beta.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: v0.8.0-beta.1
date: 2024-08-26T19:31:41Z
tag: v0.8.0-beta.1
prerelease: false
---

## What's New
**General**
- Captain/views filters @captain-Akshay (#2736)
- upgrade schemas to v0.7.26 @MUzairS15 (#2735)
- added learning-path content to views @captain-Akshay (#2734)
- Revert \Revert
16 changes: 16 additions & 0 deletions content/en/cloud/reference/releases/v0.8.0-beta.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.8.0-beta.2
date: 2024-08-27T00:22:18Z
tag: v0.8.0-beta.2
prerelease: false
---

## What's New
**General**
- bump schemas @aabidsofi19 (#2739)

## Contributors

Thank you to our contributors for making this release possible:
@Jougan-0, @aabidsofi19 and @l5io

18 changes: 18 additions & 0 deletions content/en/cloud/reference/releases/v0.8.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: v0.8.0
date: 2024-08-27T09:28:51Z
tag: v0.8.0
prerelease: false
---

## What's New
**General**
- fix integrations api @MUzairS15 (#2741)
- Empty state for in single catalog page @sudhanshutech (#2740)
- [UI]:Making Mastering Meshery, Learning path UI more prominent @SAHU-01 (#2721)

## Contributors

Thank you to our contributors for making this release possible:
@MUzairS15, @SAHU-01, @captain-Akshay, @l5io and @sudhanshutech

21 changes: 21 additions & 0 deletions content/en/cloud/reference/releases/v0.8.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: v0.8.1
date: 2024-08-28T19:20:53Z
tag: v0.8.1
prerelease: false
---

## What's New
**General**
- Update Token handlers with API standards @singh1203 (#2705)
- [chore] Rename service mesh keys to cloud native infrastructure @dragon-slayer875 (#2595)
- Migrate connection APIs to follow API standards @Yashsharma1911 (#2711)
- sistent bump @captain-Akshay (#2743)
- learning-path theme colors @captain-Akshay (#2742)
- Update Plan, Subscriptions & meshmodels handlers with API standards @singh1203 (#2710)

## Contributors

Thank you to our contributors for making this release possible:
@MUzairS15, @Yashsharma1911, @captain-Akshay, @dragon-slayer875, @l5io, @singh1203 and captain-Akshay

16 changes: 16 additions & 0 deletions content/en/cloud/reference/releases/v0.8.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.8.2
date: 2024-08-29T18:45:01Z
tag: v0.8.2
prerelease: false
---

## What's New
**General**
- [Learning Path] Interpreting Meshery Designs @Alero-Awani (#2738)

## Contributors

Thank you to our contributors for making this release possible:
@Alero-Awani, @MUzairS15, @l5io and @leecalcote

17 changes: 17 additions & 0 deletions content/en/cloud/reference/releases/v0.8.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: v0.8.3
date: 2024-08-30T20:54:15Z
tag: v0.8.3
prerelease: false
---

## What's New
**General**
- fix: learning-path toc @captain-Akshay (#2747)
- [chore] fix missing comma @dragon-slayer875 (#2745)

## Contributors

Thank you to our contributors for making this release possible:
@captain-Akshay, @dragon-slayer875, @l5io and captain-Akshay

16 changes: 16 additions & 0 deletions content/en/cloud/reference/releases/v0.8.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.8.4
date: 2024-08-31T09:53:34Z
tag: v0.8.4
prerelease: false
---

## What's New
**General**
- Fix admin not able to edit others private design @Yashsharma1911 (#2748)

## Contributors

Thank you to our contributors for making this release possible:
@MUzairS15, @Yashsharma1911, @l5io and @shubham251972

18 changes: 18 additions & 0 deletions content/en/cloud/reference/releases/v0.8.5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: v0.8.5
date: 2024-09-02T17:30:51Z
tag: v0.8.5
prerelease: false
---

## What's New
**General**
- update schemas package to v0.7.31 and meshkit to v0.7.73 @MUzairS15 (#2757)
- Bump eslint-config-next from 14.2.3 to 14.2.7 in /ui @dependabot (#2753)
- Revert ix: learning-path toc\ @captain-Akshay (#2756)

## Contributors

Thank you to our contributors for making this release possible:
@MUzairS15, @captain-Akshay, @dependabot, @dependabot[bot], @l5io and @sudhanshutech

Loading

0 comments on commit 5600e92

Please sign in to comment.