Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/layer5io/docs into MUzair…
Browse files Browse the repository at this point in the history
…S15/self-hosted/helm-values
  • Loading branch information
iArchitSharma committed Mar 25, 2024
2 parents 2e0078d + 7bacd94 commit 14ba1b4
Show file tree
Hide file tree
Showing 25 changed files with 938 additions and 78 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.119.0
HUGO_VERSION: 0.122.0
steps:
- name: Install Hugo CLI
run: |
Expand All @@ -43,13 +43,13 @@ jobs:
- name: Install Dart Sass
run: sudo snap install dart-sass
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v4
- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- name: Build with Hugo
Expand All @@ -63,7 +63,7 @@ jobs:
--minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
path: ./public

Expand All @@ -77,4 +77,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
55 changes: 0 additions & 55 deletions .github/workflows/release-cloud-charts.yml

This file was deleted.

6 changes: 3 additions & 3 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ $font-qanelas: "Qanelas Soft", sans-serif, -apple-system, BlinkMacSystemFont,
"Segoe UI", Roboto, "Helvetica Neue", Arial, "Apple Color Emoji",
"Segoe UI Emoji", "Segoe UI Symbol";

@if $td-enable-google-fonts {
$td-fonts-serif: prepend($td-fonts-serif, "#{$google_font_name}");
}
// @if $td-enable-google-fonts {
// $td-fonts-serif: prepend($td-fonts-serif, "#{$google_font_name}");
// }

$font-family-sans-serif: $td-fonts-serif;
$font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas,
Expand Down
Binary file modified content/en/cloud/identity/users/notification-preferences.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 18 additions & 7 deletions content/en/cloud/identity/users/notification-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,34 @@ categories: [Identity]
tags: [users]
---

Layer5 Cloud offers a range of user-configurable preferences, allowing you to control the types of emails you receive.
Layer5 Cloud offers a range of user-configurable preferences that allows you to control the types of email notifications you receive.

<img src="/cloud/identity/users/notification-preferences.gif" alt="Add User" />
<img src="/cloud/identity/users/notification-preferences.gif" alt="How to set your notifications preferences" />

## To change the notification preferences

1. Sign into [Layer5 Cloud](https://meshery.layer5.io)

2. Visit **Account** > [Preferences](https://meshery.layer5.io/account/preferences)

3. Under “Notifications,” choose what notifications you want to receive:
- **Acknowledgment:** You'll receive notifications about badges you've been awarded and related updates.

- **Approval Requests:** You'll be notified about Workspace, Account, Permissions, Catalog
- **Workspace Activity:** You can choose to be notified about:

- **Organization Activity:** When this is checked, you'll be notified when
- you're added or invited to a new organization
- you're removed from an organization
- a new user is added, invited to, or removed from your organization (provided that your organization admin has enabled notifications for these updates to be sent to organization members).

- **Workspace Activity:** You can choose to be notified about:
- Changes to Designs
- Comments on Your 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).
- Deployment in environments
- Membership Changes: team membership, user account creation/deletion
- Participating, @mentions in comments
- Participating, @mentions in comments: [Learn more](https://docs.layer5.io/meshmap/designer/comments/#mute-comment-notifications)
- Weekly summary
4. Click **Save Preferences**

You can opt out of all email notifications by toggling the button located on the right side of the Notifications.
5. Click **Save Preferences**

You can opt out of all email notifications by toggling the button located on the right side of the Notifications.
4 changes: 2 additions & 2 deletions content/en/cloud/self-hosted/deploy-with-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ weight: 1

### Kubernetes-based Installation with Helm

Layer5 offers on-premises installation of its [Meshery Remote Provider](https://docs.meshery.io/extensibility/providers): Layer5 Cloud. See the repository's full [index](https://docs.layer5.io/charts) of Layer5 Helm Charts. Contained in the Layer5 Helm repository is one chart with two subcharts.
Layer5 offers on-premises installation of its [Meshery Remote Provider](https://docs.meshery.io/extensibility/providers): Layer5 Cloud. Contained in the [Layer5 Helm repository](https://docs.layer5.io/charts) is one chart with two subcharts (see repo [index](https://docs.layer5.io/charts/index.yaml)).

#### Prerequisites

Expand Down Expand Up @@ -85,4 +85,4 @@ helm install -f ./install/helm-chart-values/layer5-cloud-values.yaml cloud ./ins

## Uninstalling the Chart



2 changes: 1 addition & 1 deletion content/en/meshmap/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Designs are declarative, descriptive characterizations of how your Kubernetes in
- Access to Designs may be granted to one or more users.

### Controlling Access to Designs
When creating a new design by default it's visibility level will be set to __public__ unless you are an active Lara, five subscriber, in which case you can change this default to __private__.
When creating a new design, by default its visibility will be set to __public__ unless you are an active Layer5 Cloud subscriber, in which case you can change this default to __private__.

{{< alert title="Google Docs Analogy" >}}Google Docs are a useful analogy for understanding Meshery designs. In many ways a Meshery design is like a single Google Doc in that they are collaboratively authored, versioned, permissioned and can move from workspace to workspace. Workspaces, a shared collection of designs, can be likened to a Google Drive, a shared collection of files.{{< /alert >}}

81 changes: 81 additions & 0 deletions content/en/meshmap/designer/share-resource/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Sharing Designs
description: >
Share design with other users and use control access to manage design access permissions and visibility.
weight: 3
categories: [Designer]
tags: [designs, collaboration, review]
---

## Overview

In MeshMap, you can share your designs or designs for which you have permission to share with other members of your organization and teams, and you can control access permissions. This page describes the different access types for designs and how to effectively use them.

{{< alert title="Note">}}
- You can share and use control access to manage views permissions and visibility also with same methods.
{{< /alert >}}

## Visibility

Designs and Views have visibility statuses that define who can access your designs. These options offer different levels of exposure for your designs:

- **Private:** Designs or Views with visibility status private defines only you, the creator, and the user or team that have access based on granted access permission can view and edit the design. Other users cannot access it unless you explicitly share it with them.

- **Public:** Making a design public allows anyone within your organization to view, comment on, and edit the design. This feature is useful for sharing best practices, reference architectures, or contributions within your organization. However, as the owner of the design, you can restrict permissions for individual users or teams by adding and customizing access permissions. We will discuss how you can do this in the next section.

- **Published:** The published visibility setting is designed for sharing designs with a wider audience. Published designs become discoverable to other Meshery users and allows them to view, download and clone the design. Users can find published designs through [Meshery Catalog](https://meshery.io/catalog) and catalog tab within MeshMap.

## Granting access for Individual Users

As a design owner, you have granular control over access permissions for your designs.

Following steps shows how you can grant access to individual users:

- Open your design in MeshMap.
- Click the "Share" button located on top right corner.
- Enter the name or email addresses of the users you want to share the design with.
- Define the access type for each user (e.g., view, comment, edit). You can choose from predefined options.

You can also change visibility status between public and private of design from here.

## Access types and their Impact:

In share modal, you have different access types that you can assign to users or teams for your designs.

- View: Users with view access can see the design details but cannot modify them.
- Comment: Comment access allows users to add comments and suggestions to the design, facilitating discussions and feedback.
- Edit: Edit access allows users to modify configurations, add components, deploy design, and essentially alter the design. While Editors have extensive access, they do not have all the privileges of the Owner like deleting designs.
- Owner: Owner access grants the highest level of permission, includes all access types available like view, comment and edit. Owners have full control over the design and its settings. However, it's important to note that presently MeshMap does not support transferring the design ownership.

The Owner, Editor, and Viewer access types are hierarchical, meaning that the Owner access includes the edit access, and the Edit access includes the view access.

If there are explicit access type set for a user, that will take precedence and be considered active. Otherwise, the access type assigned to the team will be used if the user is part of team and team has access.

For example, if Sarah has been granted specific access type, that will be active. However, if no specific access permission are set for Sarah, but she's part of a team with access, then the access type of that team will apply to her.

## Revoking, and Re-inviting Access:

You can manage access permissions at any time by revisiting the "Share" modal. This modal allows you to grant access to new users, revoke access or even update the access permissions of current users.

## Share design via link

You can share your design via link, for that revisit the "Share" modal and click on "Copy Link" button. You will be allowed to share the link only if your design's visibility status is public, anyone who click the link or you share with can be able to access your design. It's important to understand that currently making design public allows users to view, comment and edit the design.

This can be useful when you want to share design with multiple users without explicitly giving the access.

## Granting access for Teams (Upcoming feature)

In an upcoming feature, MeshMap will introduce the ability to grant access to entire teams, simplify the process of collaboration and sharing within your organization. This feature will offer a convenient way to manage permissions for groups of users who are working together on projects or tasks.

With this new capability, you'll be able to designate specific teams within your organization and grant them access to designs. Instead of individually assigning permissions to each member, you can simply assign permissions to the team as a whole, and manage access permission like view, comment and edit for team.

**Understanding the Implications of adding a Design to a Workspace:**

When you add design to a workspace, it signifies that all teams associated with that workspace will be allowed to access your designs even if it is private, however you can update the access type of team by revisiting the "Share" modal within MeshMap.

[Learn more about auditing the access permission within workspace](/cloud/spaces/workspaces/)

{{< alert title="Note">}}
- The 'Share' feature is currently in its beta phase, and we may introduce updates or improvements over time.
- Your feedback is invaluable! If you encounter any issues or have suggestions for enhancement, please take a moment to provide feedback.
{{< /alert >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/visualizer/images/ViewInfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 14ba1b4

Please sign in to comment.