Skip to content

Commit

Permalink
Merge branch 'master' into consolidation
Browse files Browse the repository at this point in the history
  • Loading branch information
iArchitSharma committed Mar 6, 2024
2 parents dff34c5 + f44d47e commit 4f251ef
Show file tree
Hide file tree
Showing 24 changed files with 228 additions and 11 deletions.
6 changes: 6 additions & 0 deletions .github/labeler.yml
@@ -0,0 +1,6 @@

component/cloud-docs:
- "content/en/cloud/**/*"

component/meshmap-docs:
- "content/en/meshmap/**/*"
14 changes: 14 additions & 0 deletions .github/workflows/labeler.yml
@@ -0,0 +1,14 @@
name: "Pull Request Labeler"
on:
- pull_request_target

jobs:
triage:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-22.04
steps:
- uses: actions/labeler@v4
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
63 changes: 62 additions & 1 deletion assets/scss/_elements_project.scss
Expand Up @@ -88,4 +88,65 @@ div.tip {
height: 22%;
float: right;
border-radius: 50%;
}
}

.prevBtn {
$btn-color: $primary;
$btn-color-dark: shade($btn-color, 40%);
color: tint($btn-color);

&:before {
content: '';
// @include absolute(0,0,0,0);
background-color: $btn-color-dark;
transform: translateX(-100%);
}

&:hover {
color: tint($btn-color, 75%);

&:before {
transform: translateX(0);
}
}
}

.pagination-nav {
grid-gap: 1rem;
display: grid;
gap: 1rem;
grid-template-columns: repeat(2, 1fr);
}


.pagination-nav__link {
border: 1px solid $lightslategray;
border-radius: 0.4rem;
display: block;
height: 100%;
line-height: 1.25;
padding: 1rem;
transition: border-color 200ms cubic-bezier(0.08,0.52,0.52,1);
}

.pagination-nav__link:hover {
border-color: $primary;
}

.pagination-nav__link--next {
grid-column: 2 / 3;
text-align: right;
}

.pagination-nav__sublabel{
color:$light;
font-size:0.875rem;
font-weight:500;
margin-bottom: 0.25rem;
}

.pagination-nav__label {
font-size: 1rem;
font-weight: 600;
word-break: break-word;
}
2 changes: 2 additions & 0 deletions content/en/cloud/catalog/_index.md
Expand Up @@ -14,6 +14,8 @@ Public Catalog: https://meshery.layer5.io/catalog

The Cloud Catalog is a web-based, public catalog to facilitate easy discovery of existing designs. Designs that are published into the catalog can be, but are not always curated for known best practices and patterns. Content is published at [meshery.layer5.io/catalog](https://meshery.layer5.io/catalog), and one-click import of catalog content into Meshery Server is seamlessly integrated.

![Flow for sharing design](./images/Slide51.svg)

### Content Visibility

Each item in the catalog comes with an associated level of visibility.
Expand Down
1 change: 1 addition & 0 deletions content/en/cloud/catalog/images/Slide51.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Expand Up @@ -17,10 +17,13 @@ The first steps in starting with Layer5 are to create an account, verify your em
To sign up for an account on Layer5 Cloud, navigate to <https://cloud.layer5.io/signup>.
You may choose to either signup with your personal email or any of our supported OAuth providers like Github and Gmail. See "OAuth Providers" for more information.

![Flow for user account creation](/cloud/getting-started/images/Slide40.svg)

### 2. Verifying your email address

To ensure you can use all the features in your Layer5 plan, verify your email address after signing up for a new account. For more information, see "Verifying your email address."


<!-- considering we would want to use 2FA in future
4. Configuring two-factor authentication
Expand All @@ -30,9 +33,10 @@ Optionally, after you have configured 2FA, add a passkey to your account to enab

### 3. Signing in to Layer5 Cloud

To sign in to Layer5 Cloud, navigate to <https://cloud.layer5.io/login>. Use your new credentials to sign in. In case you have signed up with OAuth provider, you will be redirected to the provider's login page.
To sign in to Layer5 Cloud, navigate to <https://meshery.layer5.io/login>. Use your new credentials to sign in. In case you have signed up with OAuth provider, you will be redirected to the provider's login page.
On successful login, you will be prompted to setup your first organization and workspace.


### 4. Creating an organization

Organization are unit of tenant in Layer5 Cloud. Every user on Layer5 Cloud is part of at least one organization. You can create your own organization or join an existing one. By default you are the owner of the organization you create.
Expand Down
1 change: 1 addition & 0 deletions content/en/cloud/getting-started/images/Slide40.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions content/en/cloud/getting-started/images/Slide49.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions content/en/cloud/getting-started/support.md
@@ -0,0 +1,34 @@
---
title: Support
description: If you have any questions, encounter any issues, or need assistance with anything related to our platform, please don't hesitate to reach out to us.
weight: 1
---

At Layer5 Cloud, we're here to help you every step of the way. If you have any questions, encounter any issues, or need assistance with anything related to our platform, please don't hesitate to reach out to us. Our dedicated support team is committed to providing you with the help and guidance you need.

### Contacting Support

You can contact Layer5 support in the following ways:

- **Email**: Send us an email at [support@layer5.io](mailto:support@layer5.io) with your questions or concerns. Our support team will respond to you as soon as possible and assist you with resolving any issues.

- **Community Forum**: Join our vibrant [community forum](https://discuss.layer5.io/) where you can ask questions, share your experiences, and connect with other users. Our community members and moderators are here to help you and provide valuable insights and assistance.

### Account Recovery

If you've forgotten your Layer5 Cloud account password, don't worry. You can easily recover your account using the following steps:

1. Go to the Layer5 Cloud [login page](https://meshery.layer5.io/login).

2. On the login page, click on the "Forgot Password" link below the login form.

3. Enter the email address associated with your Layer5 Cloud account and click "Submit."

4. You'll receive an email with instructions on how to reset your password. Follow the instructions provided in the email to reset your password.

5. Once you've clicked the password reset link in the email, you'll be directed to a page where you can create a new password for your account. Enter your new password and confirm it, then click "Submit" to save your changes.

6. After successfully resetting your password, you can now login to your Layer5 Cloud account using your new password.

![Account Recovery](/cloud/getting-started/images/Slide49.svg)

1 change: 1 addition & 0 deletions content/en/cloud/identity/users/Slide41.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions content/en/cloud/identity/users/user-management.md
Expand Up @@ -35,10 +35,13 @@ Add or remove users from the selected organization.

<img src="/cloud/identity/users/add-user.gif" alt="Add User" />

![Flow for organization and team membership](/cloud/identity/users/Slide41.svg)

## Invite User

Invite users to join your organization. Specify the user's name and email address and tailor their involvement by adding them to **organizations** and **teams**, optionally assigning predefined roles.


{{< alert type="info" title="Note" >}}
An Organization Admin can assign organization roles to users but provider roles can only be assigned by Provider Admins. For more information, see [Roles](/cloud/security/roles).
{{< /alert >}}
5 changes: 3 additions & 2 deletions content/en/cloud/overview/_index.md
@@ -1,11 +1,12 @@
<!-- ---
---
title: Overview
description: Here's where your user finds out if your project is for them.
weight: 2
categories: [Examples, Placeholders]
tags: [test, docs]
draft: true
---
<!--
{{% pageinfo %}}
Page under construction.
{{% /pageinfo %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/cloud/self-hosted/_index.md
Expand Up @@ -27,7 +27,7 @@ White-labeling is a feature that allows you to customize the appearance and bran

Meshery acknowledges the importance of air-gapped deployments and ensures content support for such environments. Content registered should be available even in the absence of internet connectivity, thus aligning with Meshery's commitment to versatile deployment scenarios.

{{< alert title="As as Service" >}}Connect to Layer5 Cloud and have your MeshMap designs versioned and available for team sharing and real-time collaboration.{{< /alert >}}
{{< alert title="As a Service" >}}Connect to Layer5 Cloud and have your MeshMap designs versioned and available for team sharing and real-time collaboration.{{< /alert >}}

### Kubernetes-based Installation with Helm

Expand Down
2 changes: 2 additions & 0 deletions content/en/cloud/tutorials/sharing-a-workspace.md
Expand Up @@ -19,6 +19,8 @@ In your browser, go to [Layer5 Cloud](https://meshery.layer5.io).
2. Click Share.
3. Enter the email addresses of the individual(s) you want to share with.

![Flow for sharing designs](/cloud/catalog/images/Slide51.svg)

## Stop, limit, or change Workspace sharing

After you share a workspace, you can stop sharing at any time. You can also control if teams you've shared with can change or share your workspace and Designs within it.
Expand Down
22 changes: 22 additions & 0 deletions content/en/meshmap/designer/comments/_index.md
Expand Up @@ -68,6 +68,28 @@ After a comment has been resolved, there might be situations where you need to r

<img src="./comments-unresolved.gif" alt="Unresolving comments in designer" width="600">

### Mute Comment Notifications

Customize your notification preferences to mute email notifications for comments on your design. With notifications for new comments silenced, you won't receive email notifications for new comments on your design. This can be useful if you want to temporarily pause notifications or reduce email clutter.

<img src="./comment-notificationBell.png" alt="Turn Off notification from comments in designer" style="width:auto">

**What Muting Affects:**

- *Muted Design's Comment Thread:* This includes all subsequent replies within the same thread, whether directed at you or not.
- *Your Mentions:* You won't receive email alerts when someone mentions you in the muted design's comment thread.

**What Muting Doesn't Affect:**

- *Mentions in Other Designs:* You'll still be notified if someone mentions you in new or existing comment threads on other designs in your portfolio.
- *New Comment Threads:* Muting only applies to the specific comment thread it's activated on. New threads on the same design will trigger notifications as usual.

{{< alert title="Remember">}}
- While email alerts are muted, you can still access and view all comments on the design at any time.
- 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
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions content/en/meshmap/tutorials/_index.md
@@ -1,10 +1,11 @@
<!-- ---
---
title: Tutorials
description: Show your user how to work through some end to end examples.
date: 2023-10-30
weight: 8
draft: true
---
<!--
{{% pageinfo %}}
Page under construction.
{{% /pageinfo %}}
Expand Down
1 change: 1 addition & 0 deletions content/en/meshmap/tutorials/collaborative-editing.md
Expand Up @@ -4,6 +4,7 @@ description: >
Learn about Collaborative Editing
weight: 5
categories: [Designer]
draft: true
---

{{% pageinfo %}}
Expand Down
1 change: 1 addition & 0 deletions content/en/meshmap/tutorials/publishing-to-catalog.md
Expand Up @@ -3,6 +3,7 @@ title: Publishing to Catalog
description: >
Learn to Publish to Catalog
weight: 4
draft: true
---

{{% pageinfo %}}
Expand Down
4 changes: 2 additions & 2 deletions layouts/docs/baseof.html
Expand Up @@ -6,7 +6,7 @@
class="no-js"
>
<head>
{{ partial "head.html" . }} {{ partial "favicon.html" . }}
{{ partial "head.html" . }}
</head>
<body
class="td-{{ .Kind }}{{ with .Page.Params.body_class }} {{ . }}{{ end }}"
Expand All @@ -25,7 +25,7 @@
<main class="col-12 col-md-9 col-xl-8 ps-md-5" role="main">
{{ partial "version-banner.html" . }} {{ if not
.Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" .
}}{{ end }} {{ block "main" . }}{{ end }}
}}{{ end }} {{ block "main" . }}{{ end }} {{ partial "pager.html" . }}
</main>
</div>
</div>
Expand Down
3 changes: 3 additions & 0 deletions layouts/docs/single.html
@@ -0,0 +1,3 @@
{{ define "main" }}
{{ .Render "content" }}
{{ end }}
12 changes: 10 additions & 2 deletions layouts/partials/head.html
Expand Up @@ -11,7 +11,15 @@
<meta name="robots" content="noindex, nofollow">
{{ end -}}

{{ partialCached "favicons.html" . }}
<meta property="og:title" content="{{ .Title }}">
<meta property="og:description" content="{{ .Description }}">
<meta property="og:image" content="/images/layer5-gradient.webp">
<meta property="og:url" content="{{ .Permalink | absURL }}">
<meta property="og:type" content="website">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="/images/layer5-gradient.webp">

{{ partialCached "favicon.html" . }}
<title>
{{- if .IsHome -}}
{{ .Site.Title -}}
Expand Down Expand Up @@ -67,4 +75,4 @@
For details, see https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch.` -}}
{{ end -}}

{{ end -}}
{{ end -}}
50 changes: 50 additions & 0 deletions layouts/partials/pager.html
@@ -0,0 +1,50 @@

{{ $currentNode := . }}

{{ template "menu-nextprev" dict "menu" .Site.Home "currentnode" $currentNode }}

{{ define "menu-nextprev" }}
{{$currentNode := .currentnode }}
{{ if ne .menu.Params.hidden true}}
{{if hasPrefix $currentNode.RelPermalink .menu.RelPermalink }}
{{ $currentNode.Scratch.Set "NextPageOK" "OK" }}
{{ $currentNode.Scratch.Set "prevPage" ($currentNode.Scratch.Get "prevPageTmp") }}
{{else}}
{{if eq ($currentNode.Scratch.Get "NextPageOK") "OK"}}
{{ $currentNode.Scratch.Set "NextPageOK" nil }}
{{ $currentNode.Scratch.Set "nextPage" .menu }}
{{end}}
{{end}}
{{ $currentNode.Scratch.Set "prevPageTmp" .menu }}

{{ $currentNode.Scratch.Set "pages" .menu.Pages }}
{{ if .menu.IsHome}}
{{ $currentNode.Scratch.Set "pages" .menu.Sections }}
{{ else if .menu.Sections}}
{{ $currentNode.Scratch.Set "pages" (.menu.Pages | union .menu.Sections) }}
{{end}}
{{ $pages := ($currentNode.Scratch.Get "pages") }}

{{ range $pages.ByWeight }}
{{ template "menu-nextprev" dict "menu" . "currentnode" $currentNode }}
{{end}}
{{ end }}
{{ end }}

<nav class="pagination-nav mt-5" aria-label="Docs pages">
{{$showPrevNext := (and (not .Params.disableNextPrev) (not .Site.Params.disableNextPrev))}}
{{if $showPrevNext}}
{{with ($.Scratch.Get "prevPage")}}
<a class="pagination-nav__link pagination-nav__link--prev" href="{{.RelPermalink}}">
<div class="pagination-nav__sublabel">Previous</div>
<div class="pagination-nav__label"><i class="fa fa-chevron-left"></i> {{.Title}}</div>
</a>
{{end}}
{{with ($.Scratch.Get "nextPage")}}
<a class="pagination-nav__link pagination-nav__link--next" href="{{.RelPermalink}}">
<div class="pagination-nav__sublabel">Next</div>
<div class="pagination-nav__label">{{.Title}} <i class="fa fa-chevron-right"></i></div>
</a>
{{end}}
{{end}}
</nav>
Binary file added static/images/layer5-gradient.webp
Binary file not shown.

0 comments on commit 4f251ef

Please sign in to comment.