Skip to content

Commit

Permalink
Merge pull request meshery#8128 from thisiskaransgit/docs-fix
Browse files Browse the repository at this point in the history
  • Loading branch information
alphaX86 committed Aug 19, 2023
2 parents a03063e + dccdea4 commit 736b506
Show file tree
Hide file tree
Showing 8 changed files with 76 additions and 27 deletions.
12 changes: 12 additions & 0 deletions docs/_data/mesheryctlcommands/cmds.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docs/_data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,15 @@
- title: Deploying Sample Applications
url: guides/sample-apps
# - title: Running SMI Conformance Tests
# url: guides/smi-conformance
# 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
Expand Down
2 changes: 1 addition & 1 deletion docs/_sass/code.scss
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ pre::-webkit-scrollbar {
word-wrap: normal;
background-color: var(--color-primary-medium);
padding: 1rem;
overflow: scroll;
overflow: hidden;

& ::-webkit-scrollbar {
display: none;
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/guides/configuration-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 pattern subcommand section](../reference/mesheryctl/#cloud-native-pattern-configuration-and-management) for more details on the `pattern` subcommand.

## WASM Filters

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/installation/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,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

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ In this how-to, [K3d](https://github.com/rancher/k3d) will be used as it relies
<pre class="codeblock-pre">
<div class="codeblock"><div class="clipboardjs">curl -s https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash
k3d cluster create
export KUBECONFIG="$(k3d kubeconfig get 'k3s-default')"</div></div>
export $env:KUBECONFIG = "$(k3d.exe kubeconfig get 'k3s-default')"</div></div>
</pre>

If using Scoop, run the following in the PowerShell to install a Kubernetes cluster :
Expand Down
62 changes: 41 additions & 21 deletions docs/pages/project/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<details>

<summary>Signing-off on Commits (Developer Certificate of Origin)</summary>

<ul>
<li>
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.
</li>

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).
<li>
See the <a href="https://developercertificate.org"> DCO </a> file for the full text of what you must agree to
and how it works <a href="https://github.com/probot/dco#how-it-works">here</a>.
To signify that you agree to the DCO for contributions, you simply add a line to each of your
git commit messages:

```
<pre><code>
Signed-off-by: Jane Smith <[email protected]>
```
</code></pre></li>

<li>
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
<code>-s</code> or <code>--signoff</code> flag to <code>git commit</code>. 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”
```
<pre><code>$ git commit -s -m “my commit message w/signoff”</code></pre>
</li>

To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:
<li>
To ensure all your commits are signed, you may choose to add this alias to your global <code>.gitconfig</code>:

_~/.gitconfig_
~/.gitconfig

```
<pre><code>
[alias]
amend = commit -s --amend
cm = commit -s -m
commit = commit -s
```
</code></pre>

Or you may configure your IDE, for example, VSCode to automatically sign-off commits for you:<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"/></a>

</li>
</ul>

Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
</details>

<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a>

### Meshery Contribution Flow

Expand All @@ -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.
<details>

<summary>Prequisites for building Meshery in your development environment:</summary>

<ol>
<li><code>Go</code> version 1.19 must be installed if you want to build and/or make changes to the existing code. The binary <code>go1.19</code> should be available in your path. If you don't want to disturb your existing version of Go, then follow these <a href="https://go.dev/doc manage-install#:~:text=and%20run%20them.-,Installing%20multiple%20Go%20versions,-You%20can%20install" rel="noopener" target="_blank">instructions</a> to keep multiple versions of Go in your system.</li>
<li> <code>GOPATH</code> environment variable should be configured appropriately</li>
<li> <code>npm</code> and <code>node</code> should be installed on your machine, `node` version 19 or higher is not supported right now.</li>
<li> Fork this repository <code>git clone https://github.com/meshery/meshery.git</code>, and clone your forked version of Meshery to your development environment, preferably outside `GOPATH`.</li>
<li> <code>golangci-lint</code> should be installed if you want to test Go code, for MacOS and linux users.</li>
<li> <code>golangci-lint</code> should be installed if you want to test Go code, for MacOS and linux users.</li>
</ol>

</details>
15 changes: 14 additions & 1 deletion docs/pages/reference/mesheryctl-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ Installation, troubleshooting and debugging of Meshery and its adapters.
</tr>
{% assign command8 = site.data.mesheryctlcommands.cmds.app %}
<tr>
<td rowspan=12><a href="{{ site.baseurl }}/reference/mesheryctl/app">{{ command8.name }}</a></td>
<td rowspan=15><a href="{{ site.baseurl }}/reference/mesheryctl/app">{{ command8.name }}</a></td>
<td></td>
<td></td>
<td>{{ command8.description }}</td>
Expand Down Expand Up @@ -633,6 +633,19 @@ Installation, troubleshooting and debugging of Meshery and its adapters.
<td>{{ flag.description }}</td>
</tr>
{% endfor %}
{% assign subcommand5 = command8.subcommands.import %}
<tr>
<td><a href="{{ site.baseurl }}/reference/mesheryctl/app/import">{{ subcommand5.name }}</a></td>
<td></td>
<td>{{ subcommand5.description }}</td>
</tr>
{% for flag_hash in subcommand5.flags %}{% assign flag = flag_hash[1] %}
<tr>
<td></td>
<td>{{ flag.name }}</td>
<td>{{ flag.description }}</td>
</tr>
{% endfor %}
</thead>
</table>

Expand Down

0 comments on commit 736b506

Please sign in to comment.