From e0c67380e74ae3f32a57ec3ec2a394e2c9fd4179 Mon Sep 17 00:00:00 2001 From: Karan Singh Thakur Date: Sun, 9 Jul 2023 15:36:34 +0000 Subject: [PATCH 01/10] indexed app import subcommand Signed-off-by: Karan Singh Thakur --- docs/_data/mesheryctlcommands/cmds.yml | 12 ++++++++++++ docs/pages/reference/mesheryctl-commands.md | 15 ++++++++++++++- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/_data/mesheryctlcommands/cmds.yml b/docs/_data/mesheryctlcommands/cmds.yml index e00aae60484..1bba7493583 100644 --- a/docs/_data/mesheryctlcommands/cmds.yml +++ b/docs/_data/mesheryctlcommands/cmds.yml @@ -763,6 +763,18 @@ app: mesheryctl app view [application-name|application-id] -o json example: mesheryctl app view bookInfo -o json + import: + name: import + description: Import the app manifest into Meshery + usage: | + mesheryctl app import [flags] + flags: + file: + name: --file, -f + description: Path/URL to app file + source-type: + name: --source-type, -s + description: source type of application filter: name: filter diff --git a/docs/pages/reference/mesheryctl-commands.md b/docs/pages/reference/mesheryctl-commands.md index 1a2d5ab105f..dd25f8a7e8f 100644 --- a/docs/pages/reference/mesheryctl-commands.md +++ b/docs/pages/reference/mesheryctl-commands.md @@ -576,7 +576,7 @@ Installation, troubleshooting and debugging of Meshery and its adapters. {% assign command8 = site.data.mesheryctlcommands.cmds.app %} - {{ command8.name }} + {{ command8.name }} {{ command8.description }} @@ -633,6 +633,19 @@ Installation, troubleshooting and debugging of Meshery and its adapters. {{ flag.description }} {% endfor %} + {% assign subcommand5 = command8.subcommands.import %} + + {{ subcommand5.name }} + + {{ subcommand5.description }} + + {% for flag_hash in subcommand5.flags %}{% assign flag = flag_hash[1] %} + + + {{ flag.name }} + {{ flag.description }} + + {% endfor %} From 608ac9a02b1670cc6c75fae83173410f743b4e84 Mon Sep 17 00:00:00 2001 From: Karan Singh Thakur Date: Sun, 9 Jul 2023 15:37:13 +0000 Subject: [PATCH 02/10] fix: links Signed-off-by: Karan Singh Thakur --- docs/pages/guides/configuration-management.md | 2 +- docs/pages/installation/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/guides/configuration-management.md b/docs/pages/guides/configuration-management.md index 5fee5ebd027..e0dbd1ac996 100644 --- a/docs/pages/guides/configuration-management.md +++ b/docs/pages/guides/configuration-management.md @@ -55,7 +55,7 @@ mesheryctl pattern apply BookInfoApp This will apply the pattern BookInfoApp, which has already been imported into Meshery. -See [mesheryctl Command Reference](../reference/mesheryctl/subcommands/mesheryctl-pattern-apply.md) for more details on the `pattern` subcommand. +See [mesheryctl Command Reference](../reference/mesheryctl/#cloud-native-pattern-configuration-and-management) for more details on the `pattern` subcommand. ## WASM Filters diff --git a/docs/pages/installation/quick-start.md b/docs/pages/installation/quick-start.md index f3b6ebde154..8967c1d084b 100644 --- a/docs/pages/installation/quick-start.md +++ b/docs/pages/installation/quick-start.md @@ -66,7 +66,7 @@ Use the Meshery command line interface, [mesheryctl]({{ site.baseurl }}/guides/m You can visit the [Docker Hub](https://hub.docker.com/extensions/meshery/docker-extension-meshery) marketplace to directly install Meshery extension in your Docker Desktop. -_Download, install, and run Meshery in a single command. See all [installation methods]({{ site.baseurl }}/installation/platforms)._ +_Download, install, and run Meshery in a single command. See all [installation methods]({{ site.baseurl }}/installation)._ ## Access Meshery From 89f63412438d1d41dbc791b7da825ac506bcdfa6 Mon Sep 17 00:00:00 2001 From: Karan Singh Thakur Date: Sun, 9 Jul 2023 15:37:58 +0000 Subject: [PATCH 03/10] updated powershell command Signed-off-by: Karan Singh Thakur --- docs/pages/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/installation/windows.md b/docs/pages/installation/windows.md index af8fe25eab2..3dbcd415eab 100644 --- a/docs/pages/installation/windows.md +++ b/docs/pages/installation/windows.md @@ -137,7 +137,7 @@ In this how-to, [K3d](https://github.com/rancher/k3d) will be used as it relies 
   
curl -s https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash
 k3d cluster create
-export KUBECONFIG="$(k3d kubeconfig get 'k3s-default')"

+export $env:KUBECONFIG = "$(k3d.exe kubeconfig get 'k3s-default')"
If using Scoop, run the following in the PowerShell to install a Kubernetes cluster : From a0d2a21b4619e39b7dbf731477349fc417d948af Mon Sep 17 00:00:00 2001 From: Karan Singh Thakur Date: Sun, 9 Jul 2023 15:39:08 +0000 Subject: [PATCH 04/10] included sections in guide sidebar Signed-off-by: Karan Singh Thakur --- docs/_data/toc.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/_data/toc.yml b/docs/_data/toc.yml index da8541c46ba..89d29fc9720 100644 --- a/docs/_data/toc.yml +++ b/docs/_data/toc.yml @@ -119,12 +119,16 @@ links: - title: Deploying Sample Applications url: guides/sample-apps - # - title: Running SMI Conformance Tests - # url: guides/smi-conformance + - title: Running SMI Conformance Tests + url: guides/smi-conformance - title: Integrating Prometheus and Grafana url: guides/meshery-metrics - title: Importing Applications url: guides/importing-apps + - title: Pipelining service mesh specifications + url: guides/pipelining-service-mesh-specifications + - title: Performance Management with Meshery + url: guides/performance-management - title: Troubleshooting Guide url: guides/troubleshooting - title: Upgrading Meshery From 497e67ee3291a73139bfb2455139eda0f40efb68 Mon Sep 17 00:00:00 2001 From: Karan Singh Thakur Date: Mon, 10 Jul 2023 20:47:34 +0000 Subject: [PATCH 05/10] updated contribution page Signed-off-by: Karan Singh Thakur --- docs/_sass/code.scss | 2 +- .../project/contributing/contributing.md | 62 ++++++++++++------- 2 files changed, 42 insertions(+), 22 deletions(-) diff --git a/docs/_sass/code.scss b/docs/_sass/code.scss index aac7562fa31..35deee5911a 100644 --- a/docs/_sass/code.scss +++ b/docs/_sass/code.scss @@ -71,7 +71,7 @@ pre { word-wrap: normal; background-color: var(--color-primary-medium); padding: 1rem; - overflow: scroll; + overflow: hidden; } } diff --git a/docs/pages/project/contributing/contributing.md b/docs/pages/project/contributing/contributing.md index f3653d9c028..6a9324ca003 100644 --- a/docs/pages/project/contributing/contributing.md +++ b/docs/pages/project/contributing/contributing.md @@ -37,43 +37,55 @@ Follow these steps and you'll be right at home. To contribute to Meshery, from creating a fork to creating pull request, please follow the basic fork-and-pull request workflow described [here]({{site.baseurl}}/project/contributing/contributing-gitflow). -### Signing-off on Commits (Developer Certificate of Origin) +
+ +Signing-off on Commits (Developer Certificate of Origin) + +
    +
  • To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution. +
    • -See the [DCO](https://developercertificate.org) file for the full text of what you must agree to -and how it works [here](https://github.com/probot/dco#how-it-works). +
  • +See the DCO file for the full text of what you must agree to +and how it works here. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages: -``` +
    
 Signed-off-by: Jane Smith 
-```
+
    • +
  • In most cases, you can add this signoff to your commit automatically with the -`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email +-s or --signoff flag to git commit. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit: -``` -$ git commit -s -m “my commit message w/signoff” -``` +
    $ git commit -s -m “my commit message w/signoff”
    +
    • -To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`: +
  • +To ensure all your commits are signed, you may choose to add this alias to your global .gitconfig: -_~/.gitconfig_ +~/.gitconfig -``` +
    
 [alias]
   amend = commit -s --amend
   cm = commit -s -m
   commit = commit -s
-```
+
    + +Or you may configure your IDE, for example, VSCode to automatically sign-off commits for you: + +
    • +
-Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you: +
- ### Meshery Contribution Flow @@ -84,10 +96,18 @@ Practices for Production Environments](https://peter.bourgon.org/go-in-productio **Please note**: All `make` commands should be run in a terminal from within the Meshery's main folder. -#### Prerequisites for building Meshery in your development environment: -1. `Go` version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary `go1.19` should be available in your path. If you don't want to disturb your existing version of Go, then follow these [instructions](https://go.dev/doc/manage-install#:~:text=and%20run%20them.-,Installing%20multiple%20Go%20versions,-You%20can%20install) to keep multiple versions of Go in your system. -1. `GOPATH` environment variable should be configured appropriately -1. `npm` and `node` should be installed on your machine, `node` version 19 or higher is not supported right now. -1. Fork this repository (`git clone https://github.com/meshery/meshery.git`), and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`. -1. `golangci-lint` should be installed if you want to test Go code, for MacOS and linux users. \ No newline at end of file +
+ +Prequisites for building Meshery in your development environment: + +
    +
  1. Go version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary go1.19 should be available in your path. If you don't want to disturb your existing version of Go, then follow these instructions to keep multiple versions of Go in your system.
    2. +
  2. GOPATH environment variable should be configured appropriately
    3. +
  3. npm and node should be installed on your machine, `node` version 19 or higher is not supported right now.
    4. +
  4. . Fork this repository git clone https://github.com/meshery/meshery.git, and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`.
    5. +
  5. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    6. +
  6. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    7. +
+ +
From ff66324fa90f31ec00529764a05c4a29f4bd8a38 Mon Sep 17 00:00:00 2001 From: Karan Thakur Date: Wed, 12 Jul 2023 15:10:59 +0000 Subject: [PATCH 06/10] revert change Signed-off-by: Karan Thakur --- docs/_data/toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_data/toc.yml b/docs/_data/toc.yml index 89d29fc9720..359bb5fb456 100644 --- a/docs/_data/toc.yml +++ b/docs/_data/toc.yml @@ -119,8 +119,8 @@ links: - title: Deploying Sample Applications url: guides/sample-apps - - title: Running SMI Conformance Tests - url: guides/smi-conformance + # - title: Running SMI Conformance Tests + # url: guides/smi-conformance - title: Integrating Prometheus and Grafana url: guides/meshery-metrics - title: Importing Applications From c910a2092606f6d95a01625c0e2fec94e93c5593 Mon Sep 17 00:00:00 2001 From: Karan Thakur Date: Wed, 12 Jul 2023 15:21:18 +0000 Subject: [PATCH 07/10] update Signed-off-by: Karan Thakur --- .../project/contributing/contributing.md | 25 ------------------- 1 file changed, 25 deletions(-) diff --git a/docs/pages/project/contributing/contributing.md b/docs/pages/project/contributing/contributing.md index 6a9324ca003..ce5f2c7b50c 100644 --- a/docs/pages/project/contributing/contributing.md +++ b/docs/pages/project/contributing/contributing.md @@ -86,28 +86,3 @@ Or you may configure your IDE, for example, VSCode to automatically sign-off com - -### Meshery Contribution Flow - -Meshery is written in `Go` (Golang) and leverages Go Modules. UI is built on React and Next.js. To make building and packaging easier a `Makefile` is included in the main repository folder. - -Relevant coding style guidelines are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) and the _Formatting and style_ section of Peter Bourgon's [Go: Best -Practices for Production Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style). - -**Please note**: All `make` commands should be run in a terminal from within the Meshery's main folder. - - -
- -Prequisites for building Meshery in your development environment: - -
    -
  1. Go version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary go1.19 should be available in your path. If you don't want to disturb your existing version of Go, then follow these instructions to keep multiple versions of Go in your system.
    2. -
  2. GOPATH environment variable should be configured appropriately
    3. -
  3. npm and node should be installed on your machine, `node` version 19 or higher is not supported right now.
    4. -
  4. . Fork this repository git clone https://github.com/meshery/meshery.git, and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`.
    5. -
  5. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    6. -
  6. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    7. -
- -
From 6090e91a786ed7e3326cb2d2469279d7f3d82af1 Mon Sep 17 00:00:00 2001 From: Karan Thakur Date: Wed, 12 Jul 2023 15:22:39 +0000 Subject: [PATCH 08/10] resolved Signed-off-by: Karan Thakur --- .../project/contributing/contributing.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/pages/project/contributing/contributing.md b/docs/pages/project/contributing/contributing.md index ce5f2c7b50c..6a9324ca003 100644 --- a/docs/pages/project/contributing/contributing.md +++ b/docs/pages/project/contributing/contributing.md @@ -86,3 +86,28 @@ Or you may configure your IDE, for example, VSCode to automatically sign-off com + +### Meshery Contribution Flow + +Meshery is written in `Go` (Golang) and leverages Go Modules. UI is built on React and Next.js. To make building and packaging easier a `Makefile` is included in the main repository folder. + +Relevant coding style guidelines are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) and the _Formatting and style_ section of Peter Bourgon's [Go: Best +Practices for Production Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style). + +**Please note**: All `make` commands should be run in a terminal from within the Meshery's main folder. + + +
+ +Prequisites for building Meshery in your development environment: + +
    +
  1. Go version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary go1.19 should be available in your path. If you don't want to disturb your existing version of Go, then follow these instructions to keep multiple versions of Go in your system.
    2. +
  2. GOPATH environment variable should be configured appropriately
    3. +
  3. npm and node should be installed on your machine, `node` version 19 or higher is not supported right now.
    4. +
  4. . Fork this repository git clone https://github.com/meshery/meshery.git, and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`.
    5. +
  5. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    6. +
  6. golangci-lint should be installed if you want to test Go code, for MacOS and linux users.
    7. +
+ +
From 6818d07dd89bd9b384b88e0f2b44230a50f1b4a2 Mon Sep 17 00:00:00 2001 From: Karan Thakur Date: Wed, 12 Jul 2023 15:45:30 +0000 Subject: [PATCH 09/10] removing residuals Signed-off-by: Karan Thakur --- docs/pages/project/contributing/contributing.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/pages/project/contributing/contributing.md b/docs/pages/project/contributing/contributing.md index ffad8bc9152..8d80c727443 100644 --- a/docs/pages/project/contributing/contributing.md +++ b/docs/pages/project/contributing/contributing.md @@ -112,22 +112,5 @@ Practices for Production Environments](https://peter.bourgon.org/go-in-productio -======= -
- - -Prerequisites - - - -#### Prerequisites for building Meshery in your development environment: - -1. `Go` version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary `go1.19` should be available in your path. If you don't want to disturb your existing version of Go, then follow these [instructions](https://go.dev/doc/manage-install#:~:text=and%20run%20them.-,Installing%20multiple%20Go%20versions,-You%20can%20install) to keep multiple versions of Go in your system. -1. `GOPATH` environment variable should be configured appropriately -1. `npm` and `node` should be installed on your machine, `node` version 19 or higher is not supported right now. -1. Fork this repository (`git clone https://github.com/meshery/meshery.git`), and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`. -1. `golangci-lint` should be installed if you want to test Go code, for MacOS and linux users. - -
From d831489cd5828c5feab8e162b36b5ff6a78d4225 Mon Sep 17 00:00:00 2001 From: Aadhitya A Date: Fri, 21 Jul 2023 10:49:10 +0530 Subject: [PATCH 10/10] Update docs/pages/guides/configuration-management.md Signed-off-by: Aadhitya A --- docs/pages/guides/configuration-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/guides/configuration-management.md b/docs/pages/guides/configuration-management.md index e0dbd1ac996..8c3e9b26e73 100644 --- a/docs/pages/guides/configuration-management.md +++ b/docs/pages/guides/configuration-management.md @@ -55,7 +55,7 @@ mesheryctl pattern apply BookInfoApp This will apply the pattern BookInfoApp, which has already been imported into Meshery. -See [mesheryctl Command Reference](../reference/mesheryctl/#cloud-native-pattern-configuration-and-management) for more details on the `pattern` subcommand. +See [mesheryctl pattern subcommand section](../reference/mesheryctl/#cloud-native-pattern-configuration-and-management) for more details on the `pattern` subcommand. ## WASM Filters