diff --git a/.github/workflows/build-and-preview-docs.yml b/.github/workflows/build-and-preview-docs.yml index 283a55130b0af..fcc489400268c 100644 --- a/.github/workflows/build-and-preview-docs.yml +++ b/.github/workflows/build-and-preview-docs.yml @@ -98,7 +98,7 @@ jobs: HUGO_ENV: production HUGO_PREVIEW: "true" run: | - make docs-build-production BASE_URL="/" + make docs-build-production BASE_URL="/${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.pull_request.number }}/" find docs/public -maxdepth 1 -type d -name 'v0.*' -exec rm -rf {} + cat > docs/public/robots.txt <<'EOF' User-agent: * diff --git a/.github/workflows/hugo.yml b/.github/workflows/hugo.yml index 8048d7f191f08..a260a394eee3f 100644 --- a/.github/workflows/hugo.yml +++ b/.github/workflows/hugo.yml @@ -59,7 +59,7 @@ jobs: HUGO_ENVIRONMENT: production HUGO_ENV: production run: | - make docs-build-production BASE_URL="/" + make docs-build-production BASE_URL="/${{ github.event.repository.name }}/" cp docs/CNAME docs/public/CNAME touch docs/public/.nojekyll if [ -d gh-pages-existing/pr-preview ]; then diff --git a/docs/assets/scss/_fonts.scss b/docs/assets/scss/_fonts.scss index 9077dad2cd08a..06b1ab0d44b28 100644 --- a/docs/assets/scss/_fonts.scss +++ b/docs/assets/scss/_fonts.scss @@ -1,6 +1,6 @@ @font-face { font-family: "Qanelas Soft"; - src: url('/fonts/qanelas-soft/QanelasSoftRegular.otf') format('opentype'); + src: url('../fonts/qanelas-soft/QanelasSoftRegular.otf') format('opentype'); font-weight: 400; font-display: swap; } diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md index 701d375b5b09a..4b1f16ed65c0e 100644 --- a/docs/content/en/_index.md +++ b/docs/content/en/_index.md @@ -16,16 +16,16 @@ linkTitle: Documentation
- + }}">
Overview & Installation

- Installation + }}" class="text-black">Installation

    @@ -36,13 +36,13 @@ linkTitle: Documentation
    - + }}">
    Concepts

    - Logical + }}" class="text-black">Logical

      @@ -52,7 +52,7 @@ linkTitle: Documentation

      - Architectural + }}" class="text-black section-title">Architectural

        @@ -66,13 +66,13 @@ linkTitle: Documentation
        - + }}">
        Guides & Tutorials

        - Using Meshery CLI Guides + }}" class="text-black">Using Meshery CLI Guides

          @@ -82,7 +82,7 @@ linkTitle: Documentation

          - πŸ§‘β€πŸ”¬ Tutorials + }}" class="text-black">πŸ§‘β€πŸ”¬ Tutorials

            @@ -92,7 +92,7 @@ linkTitle: Documentation

            - Infrastructure Management + }}" class="text-black">Infrastructure Management

              @@ -102,7 +102,7 @@ linkTitle: Documentation

              - Performance Management + }}" class="text-black">Performance Management

                @@ -112,7 +112,7 @@ linkTitle: Documentation

                - Configuration Management + }}" class="text-black">Configuration Management

                  @@ -122,7 +122,7 @@ linkTitle: Documentation

                  - Troubleshooting Guides + }}" class="text-black">Troubleshooting Guides

                    @@ -133,13 +133,13 @@ linkTitle: Documentation
                    - + }}">
                    Integrations & Extensions

                    - Extensions + }}" class="text-black">Extensions

                    @@ -164,13 +164,13 @@ linkTitle: Documentation
                    - + }}">
                    Contributing & Community

                    - Community + }}" class="text-black">Community

                      @@ -181,7 +181,7 @@ linkTitle: Documentation

                      - Contributing + }}" class="text-black">Contributing

                        @@ -192,14 +192,14 @@ linkTitle: Documentation
                        - + }}">
                        Extensibility & Reference

                        - Reference + }}" class="text-black">Reference

                          @@ -210,7 +210,7 @@ linkTitle: Documentation

                          - Extensibility + }}" class="text-black">Extensibility

                            diff --git a/docs/content/en/concepts/architecture/_index.md b/docs/content/en/concepts/architecture/_index.md index 40826c0dec00c..153c22e7ac033 100644 --- a/docs/content/en/concepts/architecture/_index.md +++ b/docs/content/en/concepts/architecture/_index.md @@ -12,16 +12,16 @@ Meshery and its components are written using the following languages and technol | Components | Languages and Technologies | | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | | Meshery Server | Golang, gRPC, GraphQL, [SMP](https://smp-spec.io) | -| [Meshery Database](/concepts/architecture/database) | Golang, SQLlite | +| [Meshery Database]({{< ref "concepts/architecture/database/index.md" >}}) | Golang, SQLlite | | Meshery UI | ReactJS, NextJS, BillboardJS | | Meshery Provider UI | ReactJS, NextJS | -| [Meshery Operator](/concepts/architecture/operator) | Golang | -| [MeshSync](/concepts/architecture/meshsync) | Golang | -| [Broker](/concepts/architecture/broker) | Golang, NATS | +| [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) | Golang | +| [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) | Golang | +| [Broker]({{< ref "concepts/architecture/broker/index.md" >}}) | Golang, NATS | | [Meshery CLI](#meshery-cli) | Golang | -| --- [Extensions](/extensions) --- | | -| [Meshery Adapters](/concepts/architecture/adapters) | Golang, gRPC, [CloudEvents](https://cloudevents.io/) | -| [Meshery Remote Providers](/extensibility/providers) | _any_ - must adhere to Meshery [Extension Points](/extensibility) | +| --- [Extensions]({{< ref "extensions/_index.md" >}}) --- | | +| [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}) | Golang, gRPC, [CloudEvents](https://cloudevents.io/) | +| [Meshery Remote Providers]({{< ref "reference/extensibility/providers/index.md" >}}) | _any_ - must adhere to Meshery [Extension Points]({{< ref "reference/extensibility/_index.md" >}}) | | [Envoy WASM Filters](https://github.com/meshery-extensions/wasm-filters) | Rust and C++ | ## Deployments @@ -32,8 +32,8 @@ Meshery deploys as a set of containers. Meshery's containers can be deployed to In Meshery v0.6.0, Adapters will register with Meshery Server over HTTP POST. If Meshery Server is not available, Meshery Adapters will backoff and retry to connect to Meshery Server perpetually. - - + + _Figure: Meshery deploys inside or outside of a Kubernetes cluster_ @@ -41,8 +41,8 @@ _Figure: Meshery deploys inside or outside of a Kubernetes cluster_ Each Meshery Adapter delivers its own unique specific functionality. As such, at time of deployment, the Meshery Adapter will register its cloud native infrastructure-specific capabilities (its operations) with Meshery Server's capability registry. - - + + _Figure: Meshery Adapter Operation Registration_ @@ -50,17 +50,17 @@ _Figure: Meshery Adapter Operation Registration_ Meshery's REST API may be consumed by any number of clients. Clients need to present valid JWT token. - - + + -_Figure: Clients use Meshery's [REST API](/extensibility/api#rest), [GraphQL API](/extensibility/api#graphql), or a combination of both._ +_Figure: Clients use Meshery's [REST API]({{< ref "reference/extensibility/api.md#rest" >}}), [GraphQL API]({{< ref "reference/extensibility/api.md#graphql" >}}), or a combination of both._ ### Providers -As a point of extensibility, Meshery supports two types of [providers](/extensibility/providers): _Local_ and _Remote_. +As a point of extensibility, Meshery supports two types of [providers]({{< ref "reference/extensibility/providers/index.md" >}}): _Local_ and _Remote_. - - + +
                            Figure: Meshery Provider architecture
                            @@ -69,8 +69,8 @@ As a point of extensibility, Meshery supports two types of [providers](/extensib This diagram outlines logical constructs within Meshery and their relationships. - - + +
                            Figure: Meshery Object Model
                            @@ -79,39 +79,39 @@ This diagram outlines logical constructs within Meshery and their relationships. Meshery Operator is the multi-cluster Kubernetes operator that manages MeshSync and Meshery Broker. - - + +
                            Figure: Meshery Operator and MeshSync
                            -See the [**Operator**](/concepts/architecture/operator) section for more information on the function of an operator and [**MeshSync**](/concepts/architecture/meshsync) section for more information on the function of meshsync. +See the [**Operator**]({{< ref "concepts/architecture/operator/index.md" >}}) section for more information on the function of an operator and [**MeshSync**]({{< ref "concepts/architecture/meshsync.md" >}}) section for more information on the function of meshsync. ## Database Meshery Server's database is responsible for collecting and centralizing the state of all elements under management, including infrastructure, application, and Meshery's own components. Meshery's database, while persisted to file, is treated as a cache. - - + +
                            Figure: Meshery Docker Extension
                            -_See the [**Database**](/concepts/architecture/database) section for more information on the function of the database._ +_See the [**Database**]({{< ref "concepts/architecture/database/index.md" >}}) section for more information on the function of the database._ ## Meshery Docker Extension Meshery's Docker extension provides a simple and flexible way to design and operate cloud native infrastructure on top of Kubernetes using Docker containers. The architecture of this extension is designed to be modular and extensible, with each component serving a specific purpose within the overall deployment process. - - + +
                            Figure: Meshery Docker Extension
                            ## Meshery CLI -The Command Line Interface ( also known as [mesheryctl](/guides/mesheryctl/working-with-mesheryctl) ) that is used to manage Meshery. Use `mesheryctl` to both manage the lifecycle of Meshery itself and to access and invoke any of Meshery's application and cloud native management functions. +The Command Line Interface ( also known as [mesheryctl]({{< ref "guides/mesheryctl/working-with-mesheryctl.md" >}}) ) that is used to manage Meshery. Use `mesheryctl` to both manage the lifecycle of Meshery itself and to access and invoke any of Meshery's application and cloud native management functions. ### **Statefulness in Meshery components** @@ -120,12 +120,12 @@ concerned with a long-lived configuration, while others have no state at all. | Components | Persistence | Description | | :---------------- | :----------- | :-------------------------------------------------------------------- | -| [mesheryctl](/guides/mesheryctl/working-with-mesheryctl) | stateless | command line interface that has a configuration file | -| [Meshery Adapters](/concepts/architecture/adapters) | stateless | interface with cloud native infrastructure on a transactional basis | +| [mesheryctl]({{< ref "guides/mesheryctl/working-with-mesheryctl.md" >}}) | stateless | command line interface that has a configuration file | +| [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}) | stateless | interface with cloud native infrastructure on a transactional basis | | Meshery Server | caches state | application cache is stored in `$HOME/.meshery/` folder | -| [Meshery Providers](/extensibility/providers) | stateful | location of persistent user preferences, environment, tests and so on | -| [Meshery Operator](/concepts/architecture/operator) | stateless | operator of Meshery custom controllers, notably MeshSync | -| [MeshSync](/concepts/architecture/meshsync) | stateless | Kubernetes custom controller, continuously running discovery | +| [Meshery Providers]({{< ref "reference/extensibility/providers/index.md" >}}) | stateful | location of persistent user preferences, environment, tests and so on | +| [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) | stateless | operator of Meshery custom controllers, notably MeshSync | +| [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) | stateless | Kubernetes custom controller, continuously running discovery | ### **Network Ports** @@ -133,7 +133,7 @@ Meshery uses the following list of network ports to interface with its various c {{< network-ports >}} -See the [**Adapters**](/concepts/architecture/adapters) section for more information on the function of an adapter. +See the [**Adapters**]({{< ref "concepts/architecture/adapters.md" >}}) section for more information on the function of an adapter. ### **Meshery Connections and their Actions** @@ -142,10 +142,10 @@ See the [**Adapters**](/concepts/architecture/adapters) section for more informa | Kubernetes clusters | `system start` | Upload kubeconfig | Click "X" on chip | On click of connection chip | Yes, via MeshSync | No | No | No | No | No | | Grafana Servers | No | Enter IP/hostname into Meshery UI | Click "X" on chip | On click of connection chip | No | No | No | No | No | No | | Prometheus Servers | No | Enter IP/hostname into Meshery UI | Click "X" on chip | On click of connection chip | Yes, when metrics are configured in a dashboard | Yes | No | No | No | No | -| [Meshery Adapters](/concepts/architecture/adapters) | `system check` | Server to Adapter on every UI refresh | Click "X on" chip | Server to Adapter every click on adapter chip in UI | Server to Adapter every 10 seconds | - | Yes, as listed in meshconfig contexts | Yes, as listed in meshconfig contexts | Toggle switch needed | Toggle switch needed | -| [Meshery Operator](/concepts/architecture/operator) | `system check` | Upon upload of kubeconfig | No | On click of connection chip in UI to Server to Kubernetes to Meshery Operator | No | - | `system start` | `system stop` | Upon upload of kubeconfig & Toggle of switch | Toggle of switch | -| [MeshSync](/concepts/architecture/meshsync) | `system check` | follows the lifecycle of Meshery Operator | No | On click of connection chip in UI to Server to Kubernetes to Meshery Operator to MeshSync | Managed by Meshery Operator | On click of connection chip | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | -| [Broker](/concepts/architecture/broker) | `system check` | follows the lifecycle of Meshery Operator | No | On click of connection chip in UI to Server to Brokers exposed service port | NATS Topic Subscription | On click of connection chip | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | +| [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}) | `system check` | Server to Adapter on every UI refresh | Click "X on" chip | Server to Adapter every click on adapter chip in UI | Server to Adapter every 10 seconds | - | Yes, as listed in meshconfig contexts | Yes, as listed in meshconfig contexts | Toggle switch needed | Toggle switch needed | +| [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) | `system check` | Upon upload of kubeconfig | No | On click of connection chip in UI to Server to Kubernetes to Meshery Operator | No | - | `system start` | `system stop` | Upon upload of kubeconfig & Toggle of switch | Toggle of switch | +| [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) | `system check` | follows the lifecycle of Meshery Operator | No | On click of connection chip in UI to Server to Kubernetes to Meshery Operator to MeshSync | Managed by Meshery Operator | On click of connection chip | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | +| [Broker]({{< ref "concepts/architecture/broker/index.md" >}}) | `system check` | follows the lifecycle of Meshery Operator | No | On click of connection chip in UI to Server to Brokers exposed service port | NATS Topic Subscription | On click of connection chip | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator | follows the lifecycle of Meshery Operator |
                            diff --git a/docs/content/en/concepts/architecture/adapters/index.md b/docs/content/en/concepts/architecture/adapters.md similarity index 86% rename from docs/content/en/concepts/architecture/adapters/index.md rename to docs/content/en/concepts/architecture/adapters.md index a1b58572087b3..67d32be07f196 100644 --- a/docs/content/en/concepts/architecture/adapters/index.md +++ b/docs/content/en/concepts/architecture/adapters.md @@ -29,11 +29,11 @@ Like every Meshery component, Meshery Adapters use MeshKit. #### Is each Meshery adapter made equal? -No, different Meshery adapters are written to expose the unique value of each cloud native infrastructure. Consequently, they are not equally capable just as each cloud native infrastructure is not equally capable as the other. Each Adapter has a set of operations which are grouped based on predefined operation types. See the [extensibility](/extensibility) page for more details on adapter operations. +No, different Meshery adapters are written to expose the unique value of each cloud native infrastructure. Consequently, they are not equally capable just as each cloud native infrastructure is not equally capable as the other. Each Adapter has a set of operations which are grouped based on predefined operation types. See the [extensibility]({{< ref "reference/extensibility/_index.md" >}}) page for more details on adapter operations. #### How can I create a new adapter? -Yes, see the [extensibility](/extensibility) documentation for details how to create a new Meshery Adapter. See the Meshery Adapter Template repository as boilerplate for your new adapter. +Yes, see the [extensibility]({{< ref "reference/extensibility/_index.md" >}}) documentation for details how to create a new Meshery Adapter. See the Meshery Adapter Template repository as boilerplate for your new adapter. #### Do adapters have to be written in Golang? @@ -43,4 +43,4 @@ No. Adapters much interface with Meshery Server via gRPC. What language is used Yes. The default configuration of a Meshery deployment includes one instance of each of the Meshery adapters (that have reached a stable version status). You may choose to run multiple instances of the same type of Meshery adapter; e.g. two instances of the `meshery-istio` adapter. To do so, modify ~/.meshery/meshery.yaml to include multiple copies of the given adapter. -See the "[Multiple Adapters](/installation/multiple-adapters)" guide for more information. +See the "[Multiple Adapters]({{< ref "installation/multiple-adapters.md" >}})" guide for more information. diff --git a/docs/content/en/concepts/architecture/broker/index.md b/docs/content/en/concepts/architecture/broker/index.md index 48446f579b713..849878680f410 100644 --- a/docs/content/en/concepts/architecture/broker/index.md +++ b/docs/content/en/concepts/architecture/broker/index.md @@ -28,4 +28,4 @@ To check if your Broker instance is running smoothly (it's deployed as a Kuberne - Verify your cluster supports `LoadBalancer` or `NodePort` service types. - Make sure the Meshery Server can reach the Broker service. -Still seeing issues? The **[Meshery Troubleshooting Guide](/guides/troubleshooting/meshery-operator-meshsync)** covers common problems with the Broker, MeshSync, and Operator β€” and offers clear steps to resolve them. +Still seeing issues? The **[Meshery Troubleshooting Guide]({{< ref "guides/troubleshooting/meshery-operator-meshsync.md" >}})** covers common problems with the Broker, MeshSync, and Operator β€” and offers clear steps to resolve them. diff --git a/docs/content/en/concepts/architecture/catalog/index.md b/docs/content/en/concepts/architecture/catalog/index.md index 856b7c7f3a780..f24111b6d0399 100644 --- a/docs/content/en/concepts/architecture/catalog/index.md +++ b/docs/content/en/concepts/architecture/catalog/index.md @@ -33,12 +33,12 @@ It also supports a collaborative environment, where DevOps engineers can share t 2. Open a terminal or command prompt. 3. Use the Meshery CLI commands to interact with the catalog. `mesheryctl design` 4. Follow the prompts or instructions provided by the Meshery CLI help. - - Apply [design file](/guides/configuration-management): `mesheryctl design apply --file [path to design file | URL of the file]` + - Apply [design file]({{< ref "guides/configuration-management/_index.md" >}}): `mesheryctl design apply --file [path to design file | URL of the file]` - Delete design file: `mesheryctl design delete --file [path to design file]` - View design file: `mesheryctl design view [design name | ID]` - List all designs: `mesheryctl design list` -5. [Importing](/reference/mesheryctl#cloud-native-pattern-configuration-and-management) a design. `mesheryctl design import -f [file-path] -s [manifest | compose | helm]` -6. Applying [WASM Filter](/guides/configuration-management#wasm-filters). `mesheryctl filter import [file | URL] --wasm-config [filepath|string]` +5. [Importing]({{< ref "reference/mesheryctl/_index.md#cloud-native-pattern-configuration-and-management" >}}) a design. `mesheryctl design import -f [file-path] -s [manifest | compose | helm]` +6. Applying [WASM Filter]({{< ref "guides/configuration-management/_index.md#wasm-filters" >}}). `mesheryctl filter import [file | URL] --wasm-config [filepath|string]` ### Publishing a Design to Meshery Catalog diff --git a/docs/content/en/concepts/architecture/database/index.md b/docs/content/en/concepts/architecture/database/index.md index 9dc9454ea578d..59cb9ced5d523 100644 --- a/docs/content/en/concepts/architecture/database/index.md +++ b/docs/content/en/concepts/architecture/database/index.md @@ -7,7 +7,7 @@ aliases: ## What are the Meshery Databases? -Meshery Databases function as repositories for [MeshSync](/concepts/architecture/meshsync), user preferences and system settings. Both databases are considered ephemeral and should be treated as caches. Data retention is tethered to the lifetime of their Meshery Server instance. [Remote Providers](/extensibility/providers) may offer long-term data persistence. Meshery's APIs offer mechanisms for clients, like [`mesheryctl`](/reference/mesheryctl) and Meshery UI to retrieve data. +Meshery Databases function as repositories for [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}), user preferences and system settings. Both databases are considered ephemeral and should be treated as caches. Data retention is tethered to the lifetime of their Meshery Server instance. [Remote Providers]({{< ref "reference/extensibility/providers/index.md" >}}) may offer long-term data persistence. Meshery's APIs offer mechanisms for clients, like [`mesheryctl`]({{< ref "reference/mesheryctl/_index.md" >}}) and Meshery UI to retrieve data. See the figure below for additional details of the data formats supported and type of data stored. @@ -16,7 +16,6 @@ See the figure below for additional details of the data formats supported and ty ### Components Meshery Database has several kinds of database implementations to support various usecases. They are listed below: -{% assign sorted = site.adapters | sort: "project_status" | reverse %} | Component | Library | | :------------- | :------------------------------------ | diff --git a/docs/content/en/concepts/architecture/meshsync/index.md b/docs/content/en/concepts/architecture/meshsync.md similarity index 87% rename from docs/content/en/concepts/architecture/meshsync/index.md rename to docs/content/en/concepts/architecture/meshsync.md index 6eb43f833a918..5e105f51befb7 100644 --- a/docs/content/en/concepts/architecture/meshsync/index.md +++ b/docs/content/en/concepts/architecture/meshsync.md @@ -10,7 +10,7 @@ aliases:

                            MeshSync

                            - MeshSync is a custom Kubernetes controller that provides tiered discovery and continual synchronization with Meshery Server as to the state of managed multi-cloud and cloud native infrastructure. It operates in one of two modes: operator or embedded. When it runs in operator mode, it is managed by the Meshery Operator. + MeshSync is a custom Kubernetes controller that provides tiered discovery and continual synchronization with Meshery Server as to the state of managed multi-cloud and cloud native infrastructure. It operates in one of two modes: operator or embedded. When it runs in operator mode, it is managed by the }}">Meshery Operator.

                        @@ -92,7 +92,7 @@ For efficient management of large Kubernetes clusters, MeshSync uses tiered disc ## Event-Driven Implementation -Meshery's event-driven approach ensures high-speed operations, making it suitable for managing both small and large clusters. [Meshery Broker](/concepts/architecture/broker) uses NATS as the messaging bus to ensure continuous communication between MeshSync and Meshery Server. In case of connectivity interruptions, MeshSync data is persisted in NATS topics. +Meshery's event-driven approach ensures high-speed operations, making it suitable for managing both small and large clusters. [Meshery Broker]({{< ref "concepts/architecture/broker/index.md" >}}) uses NATS as the messaging bus to ensure continuous communication between MeshSync and Meshery Server. In case of connectivity interruptions, MeshSync data is persisted in NATS topics. # MeshSync deployment mode @@ -100,7 +100,7 @@ MeshSync operates in one of two modes: operator or embedded. ## Operator mode (default) -When it runs in operator mode, it is managed by the Meshery Operator. +When it runs in operator mode, it is managed by the }}">Meshery Operator. ## Embedded mode @@ -120,7 +120,7 @@ When the deployment mode is switched from embedded to operator: the MeshSync lib ## How to configure MeshSync's resource discovery behavior: Can specific, "uninteresting" resources be blacklisted? -MeshSync is managed by [Meshery Operator](/concepts/architecture/operator), which watches for changes on the meshsync CRD for changes and updates the deployed MeshSync instance accordingly. You can blacklist specific Kubernetes resources from being discovered and watched by MeshSync. In order to identify the list of one or more resources for MeshSync to ignore, update the meshsync CRD using kubectl: +MeshSync is managed by [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}), which watches for changes on the meshsync CRD for changes and updates the deployed MeshSync instance accordingly. You can blacklist specific Kubernetes resources from being discovered and watched by MeshSync. In order to identify the list of one or more resources for MeshSync to ignore, update the meshsync CRD using kubectl: - Download the CRD with kubectl get crd meshsyncs.meshery.io -o yaml > meshsync.yaml - Open the downloaded file and edit the field informer_config to blacklist all the types of resources that you don't want updates from. @@ -128,7 +128,7 @@ MeshSync is managed by [Meshery Operator](/concepts/architecture/operator), whic {{% alert color="info" title="Still seeing issues?" %}} -Check the [**Meshery Troubleshooting Guide**](/guides/troubleshooting/meshery-operator-meshsync) for help with common issues. +Check the [**Meshery Troubleshooting Guide**]({{< ref "guides/troubleshooting/meshery-operator-meshsync.md" >}}) for help with common issues. {{% /alert %}} diff --git a/docs/content/en/concepts/architecture/operator/index.md b/docs/content/en/concepts/architecture/operator/index.md index 95ecfb75fb7aa..d9db5b2f60583 100644 --- a/docs/content/en/concepts/architecture/operator/index.md +++ b/docs/content/en/concepts/architecture/operator/index.md @@ -28,13 +28,13 @@ It is recommended to deploy one Meshery Operator per cluster. Meshery broker is one of the core components of the meshery architecture. This controller manages the lifecycle of broker that meshery uses for data streaming across the cluster and the outside world. -See [Meshery Broker](/concepts/architecture/broker) for more information. +See [Meshery Broker]({{< ref "concepts/architecture/broker/index.md" >}}) for more information. ### MeshSync Controller MeshSync Controller manages the lifecycle of MeshSync that is deployed for resource synchronization for the cluster. -See [MeshSync](/concepts/architecture/meshsync) for more information. +See [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) for more information. ## Operator FAQs @@ -94,6 +94,6 @@ To verify that your Meshery Operator and related components are functioning prop - Confirm that your cluster has appropriate RBAC permissions set. - Validate that Meshery Server is able to communicate with Meshery Operator. -If you're seeing issues with **Meshery Operator**, **MeshSync**, or the **Broker**, refer to the [Meshery Troubleshooting Guide](/guides/troubleshooting/meshery-operator-meshsync). +If you're seeing issues with **Meshery Operator**, **MeshSync**, or the **Broker**, refer to the [Meshery Troubleshooting Guide]({{< ref "guides/troubleshooting/meshery-operator-meshsync.md" >}}). Whether you're facing installation issues, resource syncing failures, or Broker communication problems, the guide walks you through how to identify and fix them effectively. diff --git a/docs/content/en/concepts/logical/_index.md b/docs/content/en/concepts/logical/_index.md index 00473f921f1c4..bdfa78fcc26c8 100644 --- a/docs/content/en/concepts/logical/_index.md +++ b/docs/content/en/concepts/logical/_index.md @@ -8,11 +8,11 @@ As an extensible platform, Meshery empowers you with a wide range of logical con The logical concepts included in Meshery establish a set of foundational constructs. Each logical construct is: 1. Versioned (see [Schemas](https://github.com/meshery/schemas)) -2. Extensible (see [Extension Points](/extensibility)) -3. Composable (see [Patterns](/concepts/logical/patterns)) -4. Portable (see Export/Import of [Designs](/concepts/logical/designs) and [Models](/concepts/logical/models)) -5. Interoperable (see [Compatibility Matrix](/installation/compatibility-matrix)) -6. Configurable (see [Lifecycle Management](/guides/infrastructure-management/lifecycle-management)) +2. Extensible (see [Extension Points]({{< ref "reference/extensibility/_index.md" >}})) +3. Composable (see [Patterns]({{< ref "concepts/logical/patterns.md" >}})) +4. Portable (see Export/Import of [Designs]({{< ref "concepts/logical/designs.md" >}}) and [Models]({{< ref "concepts/logical/models/index.md" >}})) +5. Interoperable (see [Compatibility Matrix]({{< ref "installation/compatibility-matrix/_index.md" >}})) +6. Configurable (see [Lifecycle Management]({{< ref "guides/infrastructure-management/lifecycle-management/index.md" >}})) 7. Documented (_you are here_) 8. Testable 9. Maintainable diff --git a/docs/content/en/concepts/logical/components/index.md b/docs/content/en/concepts/logical/components.md similarity index 90% rename from docs/content/en/concepts/logical/components/index.md rename to docs/content/en/concepts/logical/components.md index 5fce0d8998e80..c2fe42f1722b3 100644 --- a/docs/content/en/concepts/logical/components/index.md +++ b/docs/content/en/concepts/logical/components.md @@ -43,12 +43,12 @@ Components have several key properties that define their behavior: Understanding the distinction between semantic and non-semantic components helps you effectively use them to both manage real infrastructure and document your designs clearly. -Once registered with Meshery Server (in the [Registry](./registry)), components are available for inclusion in [Designs](./designs) that you create. Components can be created and published by anyone, allowing you to share you custom extensions with the community. This fosters a collaborative ecosystem where you can leverage and contribute to the growing collection of Meshery components. +Once registered with Meshery Server (in the [Registry]({{< ref "concepts/logical/registry.md" >}})), components are available for inclusion in [Designs]({{< ref "concepts/logical/designs.md" >}}) that you create. Components can be created and published by anyone, allowing you to share you custom extensions with the community. This fosters a collaborative ecosystem where you can leverage and contribute to the growing collection of Meshery components. Components having the same `kind`, `apiVersion` and `model.name` attributes are considered duplicates. - + diff --git a/docs/content/en/concepts/logical/connections/index.md b/docs/content/en/concepts/logical/connections/index.md index 0c27ca3fe599b..4f0a36e77549b 100644 --- a/docs/content/en/concepts/logical/connections/index.md +++ b/docs/content/en/concepts/logical/connections/index.md @@ -7,7 +7,7 @@ aliases: Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Connections can be assigned as resources to an Environment. {{% alert color="info" title="Connections as resources in Environments" %}} -Meshery Environments allow you to logically group related [Connections](/concepts/logical/connections) and their associated [Credentials](/concepts/logical/credentials). Environments make it easier for you to manage, share, and work with a collection of resources as a group, instead of dealing with all your Connections and Credentials on an individual basis. +Meshery Environments allow you to logically group related [Connections]({{< ref "concepts/logical/connections/index.md" >}}) and their associated [Credentials]({{< ref "concepts/logical/credentials.md" >}}). Environments make it easier for you to manage, share, and work with a collection of resources as a group, instead of dealing with all your Connections and Credentials on an individual basis. {{% /alert %}} {{% alert color="dark" title="Managed vs Unmanaged Connections" %}} @@ -22,7 +22,7 @@ Meshery tracks the status of each connections throughout the connection's lifecy ### State: Discovered -All resources discovered by [MeshSync's](/concepts/architecture/meshsync) multi-tier discovery or provided as part of config, and if Meshery can integrate, a connection with state as `Discovered` will be created. Though, the connection/resources are not tested for its reachability/usability i.e. Meshery has not made an attempt to connect or manage the connection. +All resources discovered by [MeshSync's]({{< ref "concepts/architecture/meshsync.md" >}}) multi-tier discovery or provided as part of config, and if Meshery can integrate, a connection with state as `Discovered` will be created. Though, the connection/resources are not tested for its reachability/usability i.e. Meshery has not made an attempt to connect or manage the connection. When a connection has been discovered, it will be listed in the MeshSync browser / Connections table in Meshery UI. You can self transition a particular connection to [Register](#state-registered) / [Ignore](#state-ignored) state. diff --git a/docs/content/en/concepts/logical/credentials/index.md b/docs/content/en/concepts/logical/credentials.md similarity index 100% rename from docs/content/en/concepts/logical/credentials/index.md rename to docs/content/en/concepts/logical/credentials.md diff --git a/docs/content/en/concepts/logical/designs/index.md b/docs/content/en/concepts/logical/designs.md similarity index 85% rename from docs/content/en/concepts/logical/designs/index.md rename to docs/content/en/concepts/logical/designs.md index 5364ecce50740..564935f593f68 100644 --- a/docs/content/en/concepts/logical/designs/index.md +++ b/docs/content/en/concepts/logical/designs.md @@ -7,7 +7,7 @@ aliases: Like a Google Doc, Designs are your primary tool for collaborative authorship of your infrastructure and services. A Design describes all the resources and their properties that you want for a single deployment based on Meshery’s declarative syntax (see [Meshery Schemas repo](https://github.com/meshery/schemas)). By default, Designs are stored in your user account, but can be manually exported, programmatically snapshotted, or automatically synchronized to any OCI-compatible registry (e.g. Docker Hub, AWS ECR, and so on), or Git-based repositories (coming in v0.8). You can share designs and collaborate in real-time on their creation. Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. -As the deployable unit in Meshery, a Design consists of [Components](/concepts/logical/components) and [Relationships](/concepts/logical/relationships). Designs are how you can describe your desired infrastructure state. +As the deployable unit in Meshery, a Design consists of [Components]({{< ref "concepts/logical/components.md" >}}) and [Relationships]({{< ref "concepts/logical/relationships/index.md" >}}). Designs are how you can describe your desired infrastructure state. ### Constraints on Designs @@ -28,7 +28,7 @@ As the deployable unit in Meshery, a Design consists of [Components](/concepts/l - Designs can be exported or embedded. - Designs can be embedded in web pages either as a bundle of HTML or as a React component using the [meshery-design-embed](https://www.npmjs.com/package/@meshery/meshery-design-embed) NPM package. - Designs can be snapshotted. Snapshots are immutable. Snapshots can be compared for differences between Design versions. -- Designs can be published or unpublished. Published Designs are available to all users of any Meshery instance through the [Catalog](/concepts/catalog). Unpublished Designs can still be available to other users if that Design is made public. +- Designs can be published or unpublished. Published Designs are available to all users of any Meshery instance through the [Catalog]({{< ref "concepts/architecture/catalog/index.md" >}}). Unpublished Designs can still be available to other users if that Design is made public. - Designs are versioned. Each time a Design is saved, a new version is created. - Designs can be deployed. Deploying a Design involves incorporating one or more components into your Design, configuring their relationships, and deploying them to one or more Environments. By default, any user of a Workspace can deploy a Design. @@ -48,11 +48,11 @@ As the deployable unit in Meshery, a Design consists of [Components](/concepts/l ### Controlling Access to Designs -When creating a new design by default it's visibility level will be set to **public**. [Remote Providers](/extensibility/providers) have the option of offering additional visibility levels like **private** and **published**. +When creating a new design by default it's visibility level will be set to **public**. [Remote Providers]({{< ref "reference/extensibility/providers/index.md" >}}) have the option of offering additional visibility levels like **private** and **published**. ## Meshery Designs and Models Explained -Designs are the deployable unit in Meshery. [Models](/concepts/logical/models) are the unit of packaging for Components. Components are described in Designs. Models are not directly deployed. Designs and their Components are. +Designs are the deployable unit in Meshery. [Models]({{< ref "concepts/logical/models/index.md" >}}) are the unit of packaging for Components. Components are described in Designs. Models are not directly deployed. Designs and their Components are. ### Meshery Models @@ -70,11 +70,11 @@ See the following tutorials on how to use Meshery Designs for collaboratively ma
                        - πŸ§‘β€πŸ”¬ Tutorials + }}" class="text-black">πŸ§‘β€πŸ”¬ Tutorials
                          {{< section-pages section="guides/tutorials" >}}
                        -Try the [Meshery Playground](/installation/playground) for a hands-on experience with Meshery Designs. +Try the [Meshery Playground]({{< ref "installation/playground.md" >}}) for a hands-on experience with Meshery Designs. diff --git a/docs/content/en/concepts/logical/environments/index.md b/docs/content/en/concepts/logical/environments.md similarity index 80% rename from docs/content/en/concepts/logical/environments/index.md rename to docs/content/en/concepts/logical/environments.md index f277daf0791cc..bfd6dc44827cb 100644 --- a/docs/content/en/concepts/logical/environments/index.md +++ b/docs/content/en/concepts/logical/environments.md @@ -9,7 +9,7 @@ Meshery Environments allow you to logically group related [Connections](#connect ### Assigning Resources to an Environment -Assign any number of Connections to an environment whether that Connection is managed or unmanaged (see [MeshSync](/concepts/architecture/meshsync) to learn more about managed and unmanaged Connections). In-turn, assign any number of Environments to one or more [Workspaces](/concepts/logical/workspaces). Connections (and any associated Credentials) that are assigned to an Environment become immediately available for use in any associated Workspace. +Assign any number of Connections to an environment whether that Connection is managed or unmanaged (see [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) to learn more about managed and unmanaged Connections). In-turn, assign any number of Environments to one or more [Workspaces]({{< ref "concepts/logical/workspaces.md" >}}). Connections (and any associated Credentials) that are assigned to an Environment become immediately available for use in any associated Workspace. ### Sharing Resources between Environments @@ -17,13 +17,13 @@ Environments can share resources. For example, you might create an environment n ### Deleting an Environment -Deleting an environment does not delete any resources (e.g. connections) currently contained with the environment. Resources that belong to others environments will continue to belong to those other environments. Learn more about the behavior of [lifecycle of connections](/concepts/logical/connections). +Deleting an environment does not delete any resources (e.g. connections) currently contained with the environment. Resources that belong to others environments will continue to belong to those other environments. Learn more about the behavior of [lifecycle of connections]({{< ref "concepts/logical/connections/index.md" >}}). ## Key Features - **Logical Grouping** Environments allow you to logically group related connections and their associated credentials. This makes it easier to manage, share, and work with a subset of resources instead of dealing with all your connections individually. -- **Resource Sharing** Environments can be seamlessly assigned to [Workspaces](/concepts/logical/workspaces), another essential concept in Meshery. When you assign an Environment to a Workspace, you enable resource sharing among team members. This collaborative approach simplifies the sharing of connections and resources, making it easier to work together in cloud-native environments. +- **Resource Sharing** Environments can be seamlessly assigned to [Workspaces]({{< ref "concepts/logical/workspaces.md" >}}), another essential concept in Meshery. When you assign an Environment to a Workspace, you enable resource sharing among team members. This collaborative approach simplifies the sharing of connections and resources, making it easier to work together in cloud-native environments. ## Connections and Credentials as Resources @@ -31,13 +31,13 @@ Deleting an environment does not delete any resources (e.g. connections) current Connections are an integral part of Environment. These are cloud-native resources that can be both managed and unmanaged, and they're registered by the Meshery Server. Examples of connections include Kubernetes clusters, Prometheus instances, Jaeger tracers, and Nginx web servers. -See "[Connections](/concepts/logical/connections)" section for more information. +See "[Connections]({{< ref "concepts/logical/connections/index.md" >}})" section for more information. ### Credentials Credentials in an Environment are the keys to securely authenticate and access managed connections. For example, valid Prometheus secrets or Kubernetes API tokens are essential credentials for securely interacting with these managed resources. -See "[Credentials](/concepts/logical/credentials)" section for more information. +See "[Credentials]({{< ref "concepts/logical/credentials.md" >}})" section for more information. ## Environment Lifecycle @@ -87,4 +87,4 @@ By following these lifecycle and security practices, you can maintain well-organ ## Summary -Environments represent a collection of resources in the form of Connections - both of managed and unmanaged Connections. Environment resources are comprised of Connections (and implicitly any Credentials used by those assigned Connections). Create and use environments to organize your connections and credentials into groups, and then make these resources available to you and your teams by assigning environments to [Workspaces](/concepts/logical/workspaces). \ No newline at end of file +Environments represent a collection of resources in the form of Connections - both of managed and unmanaged Connections. Environment resources are comprised of Connections (and implicitly any Credentials used by those assigned Connections). Create and use environments to organize your connections and credentials into groups, and then make these resources available to you and your teams by assigning environments to [Workspaces]({{< ref "concepts/logical/workspaces.md" >}}). \ No newline at end of file diff --git a/docs/content/en/concepts/logical/models/index.md b/docs/content/en/concepts/logical/models/index.md index b8b6773d751f5..2e8a57395cdee 100644 --- a/docs/content/en/concepts/logical/models/index.md +++ b/docs/content/en/concepts/logical/models/index.md @@ -19,10 +19,10 @@ Models serve as the foundational packaging units for Meshery's logical object re * **Extensibility:** Models are highly extensible, allowing you to define custom components, relationships, and policies. {{% alert title="Creating your own models" color="light" %}} -If you would like to create your own, augment existing models, or contribute new models, please refer to the [Contributing to Models](/project/contributing/contributing-models) guide. +If you would like to create your own, augment existing models, or contribute new models, please refer to the [Contributing to Models]({{< ref "project/contributing/contributing-models/index.md" >}}) guide. {{% /alert %}} -See [Contributing to Models](/project/contributing/contributing-models). +See [Contributing to Models]({{< ref "project/contributing/contributing-models/index.md" >}}). As a cloud native manager that provides a comprehensive set of tools for managing multi-cloud and cloud native applications and infrastructure, Meshery needs object models that can granularly characterize a wide range of systems under management from simple applications to complex microservices architectures and their infrastructure. This document describes the Meshery Model and its constituent set of entities used to represent and manage cloud and cloud native systems. @@ -32,7 +32,7 @@ Using Meshery Models, users can define and manage cloud-native systems, includin Each model (package) can be imported and exported from Meshery Server as OCI-compatible images. This makes models portable, abstracts their complexity, and encapsulates intellectual property that you might have created while designing your own models. Model packages are versioned and bundle any number of components, relationships, policies, connections, and credentials. -Models are stored in Meshery's [registry](/concepts/logical/registry) where they can be: +Models are stored in Meshery's [registry]({{< ref "concepts/logical/registry.md" >}}) where they can be: * Discovered and reused by teams * Versioned and tagged @@ -41,7 +41,7 @@ Models are stored in Meshery's [registry](/concepts/logical/registry) where they The registry provides a central location for managing and distributing your infrastructure models. -Every entity type is implemented by a [registrant](/concepts/logical/registry). Without registrants and models, Meshery can't manage any kind of infrastructure. +Every entity type is implemented by a [registrant]({{< ref "concepts/logical/registry.md" >}}). Without registrants and models, Meshery can't manage any kind of infrastructure. Most registrants configure a specific infrastructure platform (either cloud or self-hosted). Registrants vary in their capabilities. Capabilities come in the form of components, some of which represent infrastructure to be managed others of which represent functional additional functionality to augment Meshery's behavior and deepen its feature set. Some registrants offer infrastructure-specific orchestration. For example the Meshery Adapter for Istio offers integration with each of Istio's addons. @@ -78,19 +78,19 @@ Models introduce various core constructs that form the foundation of the model. ### Component -[Component](/concepts/logical/components) represent entities in the Meshery ecosystem, exposing capabilities of the underlying platform. They can be registered, created, and used by users and operators. Components have definitions, instances, and associated metadata. Components having the same `kind`, `apiVersion` and `model.name` attributes are considered duplicates. +[Component]({{< ref "concepts/logical/components.md" >}}) represent entities in the Meshery ecosystem, exposing capabilities of the underlying platform. They can be registered, created, and used by users and operators. Components have definitions, instances, and associated metadata. Components having the same `kind`, `apiVersion` and `model.name` attributes are considered duplicates. ### Policy -[Policies](/concepts/logical/policies) includes constructs for managing metrics, defining actions, and specifying color properties of components or designs. These constructs help in monitoring, controlling, and visualizing different aspects of the Meshery ecosystem. +[Policies]({{< ref "concepts/logical/policies/index.md" >}}) includes constructs for managing metrics, defining actions, and specifying color properties of components or designs. These constructs help in monitoring, controlling, and visualizing different aspects of the Meshery ecosystem. ### Relationships -[Relationships](/concepts/logical/relationships) define the nature of interaction between interconnected components in Model. They represent various types of connections and dependencies between components, such as hierarchical, network, or default relationships. Relationships have selectors, metadata, and optional parameters. +[Relationships]({{< ref "concepts/logical/relationships/index.md" >}}) define the nature of interaction between interconnected components in Model. They represent various types of connections and dependencies between components, such as hierarchical, network, or default relationships. Relationships have selectors, metadata, and optional parameters. #### Evaluation of Relationships -Meshery provides a relationship evaluation algorithm to ensure desired behavior enforcement. [Policies](policies) can be applied to components and relationships, defining rules and actions based on predefined conditions. +Meshery provides a relationship evaluation algorithm to ensure desired behavior enforcement. [Policies]({{< ref "concepts/logical/policies/index.md" >}}) can be applied to components and relationships, defining rules and actions based on predefined conditions. {{% alert title="Model Schema" color="info" %}} Model constructs are defined using a schema language called Cue. Cue is a powerful and expressive language that is well-suited for defining cloud-native constructs. @@ -98,11 +98,11 @@ Model constructs are defined using a schema language called Cue. Cue is a powerf ### Designs -[Designs](/concepts/logical/designs) are deployable units in Meshery that describe the desired infrastructure. They consist of components and patterns, allowing users to define and configure the behavior of their cloud-native applications. A design is a collection of components and patterns that represent a desired state of infrastructure. Designs are used to deploy and manage cloud-native systems. +[Designs]({{< ref "concepts/logical/designs.md" >}}) are deployable units in Meshery that describe the desired infrastructure. They consist of components and patterns, allowing users to define and configure the behavior of their cloud-native applications. A design is a collection of components and patterns that represent a desired state of infrastructure. Designs are used to deploy and manage cloud-native systems. ### Patterns -[Patterns](patterns) are reusable configuration that can be applied to components or designs. They define best practices for configuring and operating cloud-native application functionality. Patterns can be applied to components or designs, and they are read-only. +[Patterns]({{< ref "concepts/logical/patterns.md" >}}) are reusable configuration that can be applied to components or designs. They define best practices for configuring and operating cloud-native application functionality. Patterns can be applied to components or designs, and they are read-only. {{% alert title="Metadata" color="info" %}} Metadata provide additional details about a component in Meshery. They offer specific functionality or characteristics associated with a component, enhancing its capabilities. Metadata can be attached to components to customize their behavior. diff --git a/docs/content/en/concepts/logical/patterns/index.md b/docs/content/en/concepts/logical/patterns.md similarity index 100% rename from docs/content/en/concepts/logical/patterns/index.md rename to docs/content/en/concepts/logical/patterns.md diff --git a/docs/content/en/concepts/logical/registry/index.md b/docs/content/en/concepts/logical/registry.md similarity index 68% rename from docs/content/en/concepts/logical/registry/index.md rename to docs/content/en/concepts/logical/registry.md index 7a3909e9479ae..9e29945f4cb2e 100644 --- a/docs/content/en/concepts/logical/registry/index.md +++ b/docs/content/en/concepts/logical/registry.md @@ -6,20 +6,20 @@ display_title: false # Meshery Registry: A Central Hub for Capabilities -The Meshery Registry is a vital component within Meshery, serving as a centralized repository for managing a diverse range of cloud and cloud native resources. It stores and organizes crucial information such as models, categories, components, and relationships, enabling efficient interaction and utilization of these resources within the Meshery ecosystem. You can conveniently [access and manage registry data](#interacting-with-the-meshery-registry) through Meshery UI, and through Meshery CLI ([mesheryctl registry](/reference/mesheryctl/registry)). +The Meshery Registry is a vital component within Meshery, serving as a centralized repository for managing a diverse range of cloud and cloud native resources. It stores and organizes crucial information such as models, categories, components, and relationships, enabling efficient interaction and utilization of these resources within the Meshery ecosystem. You can conveniently [access and manage registry data](#interacting-with-the-meshery-registry) through Meshery UI, and through Meshery CLI ([mesheryctl registry]({{< ref "reference/mesheryctl/registry/_index.md" >}})). As the central repository for all capabilities known to Meshery, the registry contains various entities.
                        Contents of the Registry

                        - Models: Blueprints defining configurations for interacting with cloud native infrastructure. They consist of operations, components, relationships, and policies. + }}">Models: Blueprints defining configurations for interacting with cloud native infrastructure. They consist of operations, components, relationships, and policies.
                          -
                        • Components: Reusable building blocks for depicting capabilities defined within models.
                          • -
                        • Relationships: Define the nature of connections between components within a model, describing how they interact and depend on each other.
                          • -
                        • Policies: Enforce specific rules and governance for system behavior under Meshery's management.
                          • -
                        • Connections: Managed and unmanaged resources that Meshery can interact with.
                          • -
                        • Credentials: Optionally, included secrets associated with connections contained in a model.
                          • +
                        • }}">Components: Reusable building blocks for depicting capabilities defined within models.
                          • +
                        • }}">Relationships: Define the nature of connections between components within a model, describing how they interact and depend on each other.
                          • +
                        • }}">Policies: Enforce specific rules and governance for system behavior under Meshery's management.
                          • +
                        • }}">Connections: Managed and unmanaged resources that Meshery can interact with.
                          • +
                        • }}">Credentials: Optionally, included secrets associated with connections contained in a model.

                        @@ -41,7 +41,7 @@ You will find two types of models in the registry: Static and Dynamic. - **Static Models:** Pre-defined models included with each Meshery release. See the full list of static models. - **Dynamic Models:** Generated at run-time by connecting Meshery to supported platforms like Kubernetes clusters or cloud providers. -Each Meshery release comes with a built-in set of models automatically registered at Meshery Server boot-time. These built-in models offer a core set of entities for Meshery's supported [integrations](/extensibility/integrations). Once Meshery Server is running, and as it connects to and discovers your infrastructure, *dynamic models* are automatically generated. A given Meshery release may not include all possible models found in your environment, so Meshery automatically generates *and registers* new models and components based on the specific infrastructure Meshery is connected to. Dyanmic models often lack additional metadata, such as descriptions, tags, and relationships, which are typically included in static models. +Each Meshery release comes with a built-in set of models automatically registered at Meshery Server boot-time. These built-in models offer a core set of entities for Meshery's supported [integrations]({{< ref "extensions/models/_index.md" >}}). Once Meshery Server is running, and as it connects to and discovers your infrastructure, *dynamic models* are automatically generated. A given Meshery release may not include all possible models found in your environment, so Meshery automatically generates *and registers* new models and components based on the specific infrastructure Meshery is connected to. Dyanmic models often lack additional metadata, such as descriptions, tags, and relationships, which are typically included in static models. ## Interacting with the Meshery Registry @@ -55,13 +55,13 @@ The process of generating a Model (and its entities) is a multi-step process and Meshery CLI supports the generation of models from a Google Spreadsheet. The Google Spreadsheet should contain a list of model names and source locations from any supported Registrant (e.g. GitHub, Artifact Hub) repositories. The source locations can be a URL to a folder containing Kubernetes CRDs, or to a Helm Chart tar.gz, or an individual Kubernetes Manifest with custom resource definition. -See [`mesheryctl registry generate`](/reference/mesheryctl/registry/generate) for more information. +See [`mesheryctl registry generate`]({{< ref "reference/mesheryctl/registry/generate.md" >}}) for more information. ### Model Registration Once registered in the Meshery Registry, Models and their entities are available for use within that specific Meshery Server. -Meshery [Adapters](/concepts/architecture/adapters) are one example of a Registrant. Registrants are responsible for the registration of entities in the Meshery Registry. Adapters are responsible for the sourcing and registration of entities and the packaging of these enties into one or more models. +Meshery [Adapters]({{< ref "concepts/architecture/adapters.md" >}}) are one example of a Registrant. Registrants are responsible for the registration of entities in the Meshery Registry. Adapters are responsible for the sourcing and registration of entities and the packaging of these enties into one or more models. #### Using Meshery CLI to Register a Model diff --git a/docs/content/en/concepts/logical/relationships/index.md b/docs/content/en/concepts/logical/relationships/index.md index b55bf7735c9b5..e95e67cadec03 100644 --- a/docs/content/en/concepts/logical/relationships/index.md +++ b/docs/content/en/concepts/logical/relationships/index.md @@ -5,7 +5,7 @@ aliases: - /concepts/relationships/ --- -Meshery Relationships characterize how [components](./components) are connected and interact with each other. Relationships are defined within [models](./models) to aid in structuring the interrelationships between one or more components in a [design](./designs) to further in comprehending the overall structure and dependencies within managed systems. +Meshery Relationships characterize how [components]({{< ref "concepts/logical/components.md" >}}) are connected and interact with each other. Relationships are defined within [models]({{< ref "concepts/logical/models/index.md" >}}) to aid in structuring the interrelationships between one or more components in a [design]({{< ref "concepts/logical/designs.md" >}}) to further in comprehending the overall structure and dependencies within managed systems. Meshery recognizes that relationships exist in various forms and that the existence of a relationship might be interdependent upon the existence (or absence) of another relationship. To support this complexity, Meshery relationships are highly expressive, characterizing the nature of interaction of interconnected components no matter their genealogy. @@ -17,7 +17,7 @@ Meshery recognizes that relationships exist in various forms and that the existe - **Increased Flexibility:** The use of selectors, actions, and operators provides flexibility in defining and managing relationships. {{% alert color="dark" title="Contributor Guide to Meshery Relationships" %}} -If you want to create a new relationship definition or modify existing relationship definitions, see the [Contributing to Meshery Relationships](/project/contributing/contributing-relationships) guide. +If you want to create a new relationship definition or modify existing relationship definitions, see the [Contributing to Meshery Relationships]({{< ref "project/contributing/contributing-relationships.md" >}}) guide. {{% /alert %}} ## Types of Relationships @@ -29,7 +29,7 @@ Meshery supports different types of relationships to cater to various use cases: - **Edge Relationships:** These represent relationships that are visually depicted as edges connecting components in Meshery. Edge relationships are used to define how components interact with each other, such as network connections, bindings, or permissions. They are also used to identify interdependencies between components. - **TagSets Relationships:** These represent relationships between components of same Labels or Annotations key/value pairs. Labels and Annotations are two different types of Tags. Labels are often used to identify components and are visible on the design canvas. Annotations are often used to provide additional information about components. -Relationships are categorized into different kinds, types, and subtypes, so that they can be expressive of the specific manner in which one or more components relate to one another. Each type of relationship can be interpreted by Meshery UI (or other [extensions](/extensibility/extensions)) and mapped to a specific visual paradigm for the given kind relationship. Let's look at some examples of these visual paradigms; let's explore examples of ways in which relationships are represented in Meshery. +Relationships are categorized into different kinds, types, and subtypes, so that they can be expressive of the specific manner in which one or more components relate to one another. Each type of relationship can be interpreted by Meshery UI (or other [extensions]({{< ref "extensions/_index.md" >}})) and mapped to a specific visual paradigm for the given kind relationship. Let's look at some examples of these visual paradigms; let's explore examples of ways in which relationships are represented in Meshery. diff --git a/docs/content/en/concepts/logical/workspaces/index.md b/docs/content/en/concepts/logical/workspaces.md similarity index 89% rename from docs/content/en/concepts/logical/workspaces/index.md rename to docs/content/en/concepts/logical/workspaces.md index afc8e1362e8aa..30f60487f5bc2 100644 --- a/docs/content/en/concepts/logical/workspaces/index.md +++ b/docs/content/en/concepts/logical/workspaces.md @@ -36,7 +36,7 @@ After creating a Workspace, of your next steps is to resource that Workspace. Li - One or more environments can be assigned to a workspace. - Same environment can be assigned to multiple workspaces. -See "[Environments](/concepts/logical/environments)" section for more information. +See "[Environments]({{< ref "concepts/logical/environments.md" >}})" section for more information. ### Designs @@ -45,7 +45,7 @@ See "[Environments](/concepts/logical/environments)" section for more informatio - One ore more designs can be assigned to a workspace. - Same design can be assigned to multiple workspaces. -See "[Meshery Designs](/concepts/logical/designs)" section for more information. +See "[Meshery Designs]({{< ref "concepts/logical/designs.md" >}})" section for more information. ### Organizations @@ -54,8 +54,8 @@ See "[Meshery Designs](/concepts/logical/designs)" section for more information. - Remote Providers can extend Meshery to include additional identity and user management features like heirarchical organizations, or teams (as user groups), and so on. - Remote Providers can extend Meshery to offer fine-grained permissions and access control to resources like Workspaces, Designs, Environments, and so on. -Learn more about [extensible authorization](/extensibility/authorization). - +Learn more about [extensible authorization]({{< ref "reference/extensibility/authorization/index.md" >}}). + +See "[Teams](team-management)" section for more information. --> ### Connections @@ -71,7 +71,7 @@ See "[Teams](/extensions/team-management)" section for more information. --> - Connections can be assigned to one or more environments. - Same connection can be assigned to multiple environments. -See "[Connections](/concepts/logical/connections)" section for more information. +See "[Connections]({{< ref "concepts/logical/connections/index.md" >}})" section for more information. ## Best Practices @@ -82,4 +82,3 @@ To make the most of Meshery Workspaces, here are some best practices: - Regularly review and update your Workspace's resources and configurations. Meshery Workspaces enhance collaboration within your teams, providing a structured environment for sharing and managing resources. By following best practices and understanding the core components of Workspaces, you can maximize the benefits of this feature in Meshery. - diff --git a/docs/content/en/extensions/adapters/_index.md b/docs/content/en/extensions/adapters/_index.md index d54a727b3e618..37ed64292ba27 100644 --- a/docs/content/en/extensions/adapters/_index.md +++ b/docs/content/en/extensions/adapters/_index.md @@ -12,7 +12,7 @@ aliases: ## Guiding Principles of Adapter Design -Adapters allow Meshery to interface with the different cloud native infrastructure. Review the list of all available [Meshery Adapters](/concepts/architecture/adapters). See the [Meshery Architecture](/concepts/architecture) diagrams for visuals on how adapters relate to other Meshery components. +Adapters allow Meshery to interface with the different cloud native infrastructure. Review the list of all available [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). See the [Meshery Architecture]({{< ref "concepts/architecture/_index.md" >}}) diagrams for visuals on how adapters relate to other Meshery components. Meshery upholds the following guiding principles for adapter design: 1. **Adapters allow Meshery to interface with the different cloud native infrastructure, exposing their differentiated value to users.** @@ -56,8 +56,8 @@ The main purpose of the meshery-adapter-library is to: - provide a mini framework implementing the gRPC server that allows plugging in the mesh specific configuration and - operations implemented in the adapters. - provide middleware extension points -[![Meshery Adapter Library](/extensions/adapters/images/meshery-adapter-library.svg -)](/extensions/adapters/images/meshery-adapter-library.svg) +[![Meshery Adapter Library](images/meshery-adapter-library.svg +)](images/meshery-adapter-library.svg) _Figure: Displaying Meshery Adapter library architecture along with an example of integration_ diff --git a/docs/content/en/extensions/adapters/app-mesh/index.md b/docs/content/en/extensions/adapters/app-mesh/index.md index 2c0fa76b532c9..1608f9b40f3ad 100644 --- a/docs/content/en/extensions/adapters/app-mesh/index.md +++ b/docs/content/en/extensions/adapters/app-mesh/index.md @@ -7,8 +7,8 @@ adapter_version: v0.6.4 port: 10005/gRPC project_status: beta github_link: https://github.com/meshery/meshery-app-mesh -image: /extensions/adapters/app-mesh/images/app-mesh.svg -white_image: /extensions/adapters/app-mesh/images/app-mesh-white.svg +image: extensions/adapters/app-mesh/images/app-mesh.svg +white_image: extensions/adapters/app-mesh/images/app-mesh-white.svg aliases: - /service-meshes/adapters/app-mesh - /extensibility/adapters/app-mesh @@ -22,13 +22,13 @@ aliases: ### Sample Applications -- [Emojivoto](/guides/infrastructure-management/sample-apps#emojivoto) +- [Emojivoto]({{< ref "guides/infrastructure-management/sample-apps/index.md#emojivoto" >}}) - A microservice application that allows users to vote for their favorite emoji, and tracks votes received on a leaderboard. -- [Bookinfo](/guides/infrastructure-management/sample-apps#bookinfo) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md#bookinfo" >}}) -- [Httpbin](/guides/infrastructure-management/sample-apps#httpbin) +- [Httpbin]({{< ref "guides/infrastructure-management/sample-apps/index.md#httpbin" >}}) - Httpbin is a simple HTTP request and response service. diff --git a/docs/content/en/extensions/adapters/cilium/index.md b/docs/content/en/extensions/adapters/cilium/index.md index 8a024e1237298..7302abbe82e54 100644 --- a/docs/content/en/extensions/adapters/cilium/index.md +++ b/docs/content/en/extensions/adapters/cilium/index.md @@ -8,14 +8,14 @@ port: 10012/gRPC project_status: stable lab: cilium-meshery-adapter github_link: https://github.com/meshery/meshery-cilium -image: /extensions/adapters/cilium/images/cilium.svg -white_image: /extensions/adapters/cilium/images/cilium-white.svg +image: extensions/adapters/cilium/images/cilium.svg +white_image: extensions/adapters/cilium/images/cilium-white.svg aliases: - /service-meshes/adapters/cilium - /extensibility/adapters/cilium --- -The Meshery Adapter for Cilium Service Mesh is currently under construction (stable state), which means that the adapter is not functional and cannot be interacted with through the Meshery UI at the moment. Check back here to see updates. +The Meshery Adapter for Cilium Service Mesh is currently under construction (stable state), which means that the adapter is not functional and cannot be interacted with through the }}"> Meshery UI at the moment. Check back here to see updates. Want to contribute? Check our [progress](https://github.com/meshery/meshery-cilium). diff --git a/docs/content/en/extensions/adapters/consul/index.md b/docs/content/en/extensions/adapters/consul/index.md index 7f73af5325a3b..0d6045dd495a6 100644 --- a/docs/content/en/extensions/adapters/consul/index.md +++ b/docs/content/en/extensions/adapters/consul/index.md @@ -8,8 +8,8 @@ port: 10002/gRPC project_status: stable lab: consul-meshery-adapter github_link: https://github.com/meshery/meshery-consul -image: /extensions/adapters/consul/images/consul.svg -white_image: /extensions/adapters/consul/images/consul-white.svg +image: extensions/adapters/consul/images/consul.svg +white_image: extensions/adapters/consul/images/consul-white.svg aliases: - /service-meshes/adapters/consul - /extensibility/adapters/consul @@ -28,11 +28,11 @@ aliases: Meshery supports the deployment of a variety of sample applications on Meshery Adapter for Consul. Use Meshery to deploy any of these sample applications. -- [httpbin](/guides/infrastructure-management/sample-apps#httpbin) +- [httpbin]({{< ref "guides/infrastructure-management/sample-apps/index.md#httpbin" >}}) - Httpbin is a simple HTTP request and response service. -- [Bookinfo](/guides/infrastructure-management/sample-apps#bookinfo) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md#bookinfo" >}}) - The sample BookInfo application displays information about a book, similar to a single catalog entry of an online book store. -- [Image Hub](/guides/infrastructure-management/sample-apps#imagehub) +- [Image Hub]({{< ref "guides/infrastructure-management/sample-apps/index.md#imagehub" >}}) - Image Hub is a sample application written to run on Consul for exploring WebAssembly modules used as Envoy filters. ### Performance management of Consul and it workloads @@ -43,9 +43,9 @@ The Meshery Adapter for Consul will connect to Meshery Adapter for Consul's Prom ### Architecture -[![Consul Service Mesh Architecture](/extensions/adapters/consul/images/service-mesh-architecture-consul.png)](/extensions/adapters/consul/images/service-mesh-architecture-consul.png) +[![Consul Service Mesh Architecture](images/service-mesh-architecture-consul.png)](images/service-mesh-architecture-consul.png) ### Suggested Topics -- Examine [Meshery's architecture](/concepts/architecture) and how adapters fit in as a component. -- Learn more about [Meshery Adapters](/concepts/architecture/adapters). +- Examine [Meshery's architecture]({{< ref "concepts/architecture/_index.md" >}}) and how adapters fit in as a component. +- Learn more about [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). diff --git a/docs/content/en/extensions/adapters/istio/index.md b/docs/content/en/extensions/adapters/istio/index.md index 7fe3a520a07cc..2a97cae6d4a87 100644 --- a/docs/content/en/extensions/adapters/istio/index.md +++ b/docs/content/en/extensions/adapters/istio/index.md @@ -8,8 +8,8 @@ port: 10000/gRPC project_status: stable lab: istio-meshery-adapter github_link: https://github.com/meshery/meshery-istio -image: /extensions/adapters/istio/images/istio.svg -white_image: /extensions/adapters/istio/images/istio-white.svg +image: extensions/adapters/istio/images/istio.svg +white_image: extensions/adapters/istio/images/istio-white.svg aliases: - /service-meshes/adapters/istio - /extensibility/adapters/istio @@ -28,12 +28,12 @@ aliases: The Meshery Adapter for Istio includes a handful of sample applications. Use Meshery to deploy any of these sample applications: -- [Bookinfo](/guides/infrastructure-management/sample-apps#bookinfo) -- [Httpbin](/guides/infrastructure-management/sample-apps#httpbin) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md#bookinfo" >}}) +- [Httpbin]({{< ref "guides/infrastructure-management/sample-apps/index.md#httpbin" >}}) - Httpbin is a simple HTTP request and response service. -- [Online Boutique](/guides/infrastructure-management/sample-apps#online-boutique) +- [Online Boutique]({{< ref "guides/infrastructure-management/sample-apps/index.md#online-boutique" >}}) - Online Boutique Application is a web-based, e-commerce demo application from the Google Cloud Platform. -- [Image Hub](/guides/infrastructure-management/sample-apps#imagehub) +- [Image Hub]({{< ref "guides/infrastructure-management/sample-apps/index.md#imagehub" >}}) - Image Hub is a sample application written to run on Consul for exploring WebAssembly modules used as Envoy filters. ## Using Cloud Native Standards @@ -60,14 +60,14 @@ On demand, the Meshery Adapter for Istio will parse all of Istio's configuration Meshery allows you to apply configuration to your infrastructure deployment. You can paste (or type in) any Kubernetes manifest that you would like to have applied to your infrastructure, in fact, you can apply any configuration that you would like to your Kubernetes cluster. This configuration may be VirtualServices, DestinationRules or any other custom Istio resource. - - + + Add-on resources can be applied **or** deleted using this custom configuration operation. ### Suggested Topics -- Examine [Meshery's architecture](/architecture) and how adapters fit in as a component. -- Learn more about [Meshery Adapters](/architecture/adapters). +- Examine [Meshery's architecture]({{< ref "concepts/architecture/_index.md" >}}) and how adapters fit in as a component. +- Learn more about [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). diff --git a/docs/content/en/extensions/adapters/kuma/index.md b/docs/content/en/extensions/adapters/kuma/index.md index 1c0675ae86010..5184288d3512f 100644 --- a/docs/content/en/extensions/adapters/kuma/index.md +++ b/docs/content/en/extensions/adapters/kuma/index.md @@ -8,8 +8,8 @@ port: 10007/gRPC project_status: stable lab: kuma-meshery-adapter github_link: https://github.com/meshery/meshery-kuma -image: /extensions/adapters/kuma/images/kuma.svg -white_image: /extensions/adapters/kuma/images/kuma-white.svg +image: extensions/adapters/kuma/images/kuma.svg +white_image: extensions/adapters/kuma/images/kuma-white.svg aliases: - /service-meshes/adapters/kuma - /extensibility/adapters/kuma @@ -20,5 +20,5 @@ aliases: The following sample applications are available in this adapter. -- [Bookinfo](/guides/infrastructure-management/sample-apps#bookinfo) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md#bookinfo" >}}) - The sample BookInfo application displays information about a book, similar to a single catalog entry of an online book store. diff --git a/docs/content/en/extensions/adapters/linkerd/index.md b/docs/content/en/extensions/adapters/linkerd/index.md index 3b5a4bbe05356..a22eb160970d2 100644 --- a/docs/content/en/extensions/adapters/linkerd/index.md +++ b/docs/content/en/extensions/adapters/linkerd/index.md @@ -8,8 +8,8 @@ port: 10001/gRPC project_status: stable lab: linkerd-meshery-adapter github_link: https://github.com/meshery/meshery-linkerd -image: /extensions/adapters/linkerd/images/linkerd.svg -white_image: /extensions/adapters/linkerd/images/linkerd-white.svg +image: extensions/adapters/linkerd/images/linkerd.svg +white_image: extensions/adapters/linkerd/images/linkerd-white.svg aliases: - /service-meshes/adapters/linkerd - /extensibility/adapters/linkerd @@ -25,19 +25,19 @@ aliases: The Meshery Adapter for Linkerd includes the ability to deploy a variety of sample applications. Use Meshery to deploy any of these sample applications: -- [Emojivoto](/guides/infrastructure-management/sample-apps) +- [Emojivoto]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - A microservice application that allows users to vote for their favorite emoji, and tracks votes received on a leaderboard. -- [Bookinfo](/guides/infrastructure-management/sample-apps) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - The sample BookInfo application displays information about a book, similar to a single catalog entry of an online book store. -- [Linkerd Books](/guides/infrastructure-management/sample-apps) +- [Linkerd Books]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - A sample application built for demonstrating manage your bookshelf. -- [HTTPbin](/guides/infrastructure-management/sample-apps) +- [HTTPbin]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - A simple HTTP Request & Response Service. Identify overhead involved in running Linkerd, various Linkerd configurations while running different workloads and on different infrastructure. The adapter facilitates data plane and control plane performance testing. diff --git a/docs/content/en/extensions/adapters/nginx-sm/index.md b/docs/content/en/extensions/adapters/nginx-sm/index.md index 289994016a79c..0594b307a3558 100644 --- a/docs/content/en/extensions/adapters/nginx-sm/index.md +++ b/docs/content/en/extensions/adapters/nginx-sm/index.md @@ -7,8 +7,8 @@ adapter_version: v0.8.1 port: 10010/gRPC project_status: stable github_link: https://github.com/meshery/meshery-nginx-sm -image: /extensions/adapters/nginx-sm/images/nginx-sm.svg -white_image: /extensions/adapters/nginx-sm/images/nginx-sm-white.svg +image: extensions/adapters/nginx-sm/images/nginx-sm.svg +white_image: extensions/adapters/nginx-sm/images/nginx-sm-white.svg aliases: - /service-meshes/adapters/nginx-sm - /extensibility/adapters/nginx-sm @@ -26,13 +26,13 @@ The Meshery Adapter for NGINX Service Mesh is currently under construction (stab The Meshery Adapter for NGINX Service Mesh includes a handful of sample applications. Use Meshery to deploy any of these sample applications. -- [Emojivoto](/guides/infrastructure-management/sample-apps) +- [Emojivoto]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - A microservice application that allows users to vote for their favorite emoji, and tracks votes received on a leaderboard. -- [Bookinfo](/guides/infrastructure-management/sample-apps) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) -- [Httpbin](/guides/infrastructure-management/sample-apps) +- [Httpbin]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - Httpbin is a simple HTTP request and response service. diff --git a/docs/content/en/extensions/adapters/nsm/index.md b/docs/content/en/extensions/adapters/nsm/index.md index 3fd44b393a919..92cebd8fe51ed 100644 --- a/docs/content/en/extensions/adapters/nsm/index.md +++ b/docs/content/en/extensions/adapters/nsm/index.md @@ -8,8 +8,8 @@ port: 10004/gRPC project_status: stable lab: nsm-meshery-adapter github_link: https://github.com/meshery/meshery-nsm -image: /extensions/adapters/nsm/images/nsm.svg -white_image: /extensions/adapters/nsm/images/nsm.svg +image: extensions/adapters/nsm/images/nsm.svg +white_image: extensions/adapters/nsm/images/nsm.svg aliases: - /service-meshes/adapters/nsm - /extensibility/adapters/nsm @@ -37,8 +37,8 @@ Network Service Mesh allows flexibility in the choice of mechanisms used to prov The icmp responder example does this with kernel interfaces. The vpp-icmp-responder provides and consumes the same 'icmp-responder' Network Service, but has Client's and Endpoint's that use a [memif](https://www.youtube.com/watch?v=6aVr32WgY0Q) high speed memory interfaces to achieve performance unavailable via kernel interfaces. - - + + Working process @@ -52,8 +52,8 @@ This will install two Deployments: And cause each Client to get a vWire connecting it to one of the Endpoints. Network Service Mesh handles the Network Service Discovery and Routing, as well as the vWire 'Connection Handling' for setting all of this up. - - + + In order to make this case more interesting, Endpoint1 and Endpoint2 are deployed on two separate Nodes using PodAntiAffinity, so that the Network Service Mesh has to demonstrate the ability to string vWires between Clients and Endpoints on the same Node and Clients and Endpoints on different Nodes. @@ -80,8 +80,8 @@ To see the vpp-icmp-responder example in action, you can run: The simplest possible case for Network Service Mesh is to have is connecting a Client via a vWire to another Pod that is providing a Network Service. We call this case the β€˜icmp-responder’ example, because it allows the client to ping the IP address of the Endpoint over the vWire. - - + + Outcomes @@ -96,8 +96,8 @@ This will install two Deployments: And cause each Client to get a vWire connecting it to one of the Endpoints. Network Service Mesh handles the Network Service Discovery and Routing, as well as the vWire 'Connection Handling' for setting all of this up. - - + + In order to make this case more interesting, Endpoint1 and Endpoint2 are deployed on two separate Nodes using @@ -124,6 +124,6 @@ Verification ### Suggested Topics -- Examine [Meshery's architecture](/concepts/architecture) and how adapters fit in as a component. -- Learn more about [Meshery Adapters](/concepts/architecture/adapters). +- Examine [Meshery's architecture]({{< ref "concepts/architecture/_index.md" >}}) and how adapters fit in as a component. +- Learn more about [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). diff --git a/docs/content/en/extensions/adapters/tanzu-sm/index.md b/docs/content/en/extensions/adapters/tanzu-sm/index.md index 2d744f9b87771..22b8d53ef7374 100644 --- a/docs/content/en/extensions/adapters/tanzu-sm/index.md +++ b/docs/content/en/extensions/adapters/tanzu-sm/index.md @@ -7,8 +7,8 @@ adapter_version: v0.1.0 port: 10011/gRPC project_status: alpha github_link: https://github.com/meshery/meshery-tanzu-sm -image: /extensions/adapters/tanzu-sm/images/tanzu.svg -white_image: /extensions/adapters/tanzu-sm/images/tanzu.svg +image: extensions/adapters/tanzu-sm/images/tanzu.svg +white_image: extensions/adapters/tanzu-sm/images/tanzu.svg aliases: - /service-meshes/adapters/tanzu-sm - /extensibility/adapters/tanzu-sm @@ -16,5 +16,5 @@ aliases: ### Suggested Reading -- Examine [Meshery's architecture](/concepts/architecture) and how adapters fit in as a component. -- Learn more about [Meshery Adapters](/concepts/architecture/adapters). +- Examine [Meshery's architecture]({{< ref "concepts/architecture/_index.md" >}}) and how adapters fit in as a component. +- Learn more about [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). diff --git a/docs/content/en/extensions/adapters/traefik-mesh/index.md b/docs/content/en/extensions/adapters/traefik-mesh/index.md index 35eb09fa9eef0..ee0975e9ae94a 100644 --- a/docs/content/en/extensions/adapters/traefik-mesh/index.md +++ b/docs/content/en/extensions/adapters/traefik-mesh/index.md @@ -8,8 +8,8 @@ port: 10006/gRPC project_status: stable lab: traefik-meshery-adapter github_link: https://github.com/meshery/meshery-traefik-mesh -image: /extensions/adapters/traefik-mesh/images/traefik-mesh.svg -white_image: /extensions/adapters/traefik-mesh/images/traefik-mesh.svg +image: extensions/adapters/traefik-mesh/images/traefik-mesh.svg +white_image: extensions/adapters/traefik-mesh/images/traefik-mesh.svg aliases: - /service-meshes/adapters/traefik-mesh - /extensibility/adapters/traefik-mesh @@ -19,11 +19,11 @@ aliases: The Meshery Adapter for Traefik Mesh includes some sample applications operations. Meshery can be used to deploy any of these sample applications. -- [Bookinfo](/guides/infrastructure-management/sample-apps) -- [Httpbin](/guides/infrastructure-management/sample-apps) +- [Bookinfo]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) +- [Httpbin]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) - Httpbin is a simple HTTP request and response service. ## Suggested Topics -- Examine [Meshery's architecture](/concepts/architecture) and how adapters fit in as a component. -- Learn more about [Meshery Adapters](/concepts/architecture/adapters). +- Examine [Meshery's architecture]({{< ref "concepts/architecture/_index.md" >}}) and how adapters fit in as a component. +- Learn more about [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}). diff --git a/docs/content/en/extensions/images/helm-chart-color.svg b/docs/content/en/extensions/helm-snapshot/images/helm-chart-color.svg similarity index 100% rename from docs/content/en/extensions/images/helm-chart-color.svg rename to docs/content/en/extensions/helm-snapshot/images/helm-chart-color.svg diff --git a/docs/content/en/extensions/helm-snapshot.md b/docs/content/en/extensions/helm-snapshot/index.md similarity index 78% rename from docs/content/en/extensions/helm-snapshot.md rename to docs/content/en/extensions/helm-snapshot/index.md index a19123a49937a..0e8cff83a3233 100644 --- a/docs/content/en/extensions/helm-snapshot.md +++ b/docs/content/en/extensions/helm-snapshot/index.md @@ -4,7 +4,7 @@ description: Helm CLI plugin to visually render a snapshot of your Helm charts. display_title: false --- -# Helm Snapshot +# Helm Snapshot ## Extension Overview @@ -80,10 +80,10 @@ To generate a snapshot for a Helm chart located at `https://meshery.io/charts/v0 ## About Meshery Extensions -[Meshery Extensions](https://meshery.io/extensions) are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions ([docs](/extensions/)): +[Meshery Extensions](https://meshery.io/extensions) are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions ([docs]({{< ref "extensions/_index.md" >}})): -- [Adapters](/concepts/architecture/adapters): Adapters allow Meshery to interface with the different cloud native infrastructure. -- [Load Generators](/extensibility/load-generators): for performance characterization and benchmarking -- [Integrations](/extensibility/integrations): model-based support for a broad variety of design and orchestration of cloud and cloud native platforms, tools, and technologies. -- [Providers](/extensibility/providers): for connecting to different cloud providers and infrastructure platforms -- [UI Plugins](/extensibility/ui): Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins. +- [Adapters]({{< ref "concepts/architecture/adapters.md" >}}): Adapters allow Meshery to interface with the different cloud native infrastructure. +- [Load Generators]({{< ref "reference/extensibility/load-generators.md" >}}): for performance characterization and benchmarking +- [Integrations]({{< ref "extensions/models/_index.md" >}}): model-based support for a broad variety of design and orchestration of cloud and cloud native platforms, tools, and technologies. +- [Providers]({{< ref "reference/extensibility/providers/index.md" >}}): for connecting to different cloud providers and infrastructure platforms +- [UI Plugins]({{< ref "reference/extensibility/ui.md" >}}): Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins. diff --git a/docs/content/en/extensions/images/icon-color.svg b/docs/content/en/extensions/kanvas/images/icon-color.svg similarity index 100% rename from docs/content/en/extensions/images/icon-color.svg rename to docs/content/en/extensions/kanvas/images/icon-color.svg diff --git a/docs/content/en/extensions/kanvas.md b/docs/content/en/extensions/kanvas/index.md similarity index 74% rename from docs/content/en/extensions/kanvas.md rename to docs/content/en/extensions/kanvas/index.md index 538ba39d2a3fb..d254aa366dbda 100644 --- a/docs/content/en/extensions/kanvas.md +++ b/docs/content/en/extensions/kanvas/index.md @@ -6,7 +6,7 @@ description: Collaborative cloud native visual designer to design and manage inf display_title: true --- - Kanvas is a GitOps-infused cloud native visual designer for Kubernetes and cloud native applications. This extension works with your Kubernetes clusters so that you design and manage your infrastructure and applications between members of your team. This extension has two modes: Designer and Operator. Create and share your own Kubernetes deployments and patterns in Designer. Deploy your designs and manage your infrastructure using Operator. It includes multi-user collaboration features that allow teams to work together seamlessly towards achieving their goals in a more timely manner. This extension aims at removing all the challenging aspects of collaboration from the equation so that everyone on your team can be on the same page when it comes to managing cloud-native infrastructure projects. + Kanvas is a GitOps-infused cloud native visual designer for Kubernetes and cloud native applications. This extension works with your Kubernetes clusters so that you design and manage your infrastructure and applications between members of your team. This extension has two modes: Designer and Operator. Create and share your own Kubernetes deployments and patterns in Designer. Deploy your designs and manage your infrastructure using Operator. It includes multi-user collaboration features that allow teams to work together seamlessly towards achieving their goals in a more timely manner. This extension aims at removing all the challenging aspects of collaboration from the equation so that everyone on your team can be on the same page when it comes to managing cloud-native infrastructure projects. ### Features diff --git a/docs/content/en/extensions/kubectl-meshsync-snapshot.md b/docs/content/en/extensions/kubectl-meshsync-snapshot.md deleted file mode 100644 index 93cdce86f7965..0000000000000 --- a/docs/content/en/extensions/kubectl-meshsync-snapshot.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: kubectl MeshSync Snapshot -description: A native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server. -display_title: false -aliases: -- /extensions/kubectl-meshsync-snapshot ---- - -# kubectl MeshSync Snapshot - -A `kubectl` plugin for performing an ad hoc collection of resource information from a Kubernetes cluster and sending the cluster resources details to a Meshery Server. `kubectl meshsync snapshot` is a native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server. - -
                        - -## About Meshery Extensions - -[Meshery Extensions](https://meshery.io/extensions) are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions ([docs](/extensions/)): - -- [Adapters](/concepts/architecture/adapters): Adapters allow Meshery to interface with the different cloud native infrastructure. -- [Load Generators](/extensibility/load-generators): for performance characterization and benchmarking -- [Integrations](/extensibility/integrations): model-based support for a broad variety of design and orchestration of cloud and cloud native platforms, tools, and technologies. -- [Providers](/extensibility/providers): for connecting to different cloud providers and infrastructure platforms -- [UI Plugins](/extensibility/ui): Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins. \ No newline at end of file diff --git a/docs/content/en/extensions/images/meshsync.svg b/docs/content/en/extensions/kubectl-meshsync-snapshot/images/meshsync.svg similarity index 100% rename from docs/content/en/extensions/images/meshsync.svg rename to docs/content/en/extensions/kubectl-meshsync-snapshot/images/meshsync.svg diff --git a/docs/content/en/extensions/kubectl-meshsync-snapshot/index.md b/docs/content/en/extensions/kubectl-meshsync-snapshot/index.md new file mode 100644 index 0000000000000..7ba5002da758e --- /dev/null +++ b/docs/content/en/extensions/kubectl-meshsync-snapshot/index.md @@ -0,0 +1,23 @@ +--- +title: kubectl MeshSync Snapshot +description: A native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server. +display_title: false +aliases: +- /extensions/kubectl-meshsync-snapshot +--- + +# kubectl MeshSync Snapshot + +A `kubectl` plugin for performing an ad hoc collection of resource information from a Kubernetes cluster and sending the cluster resources details to a Meshery Server. `kubectl meshsync snapshot` is a native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server. + +
                        + +## About Meshery Extensions + +[Meshery Extensions](https://meshery.io/extensions) are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions ([docs]({{< ref "extensions/_index.md" >}})): + +- [Adapters]({{< ref "concepts/architecture/adapters.md" >}}): Adapters allow Meshery to interface with the different cloud native infrastructure. +- [Load Generators]({{< ref "reference/extensibility/load-generators.md" >}}): for performance characterization and benchmarking +- [Integrations]({{< ref "extensions/models/_index.md" >}}): model-based support for a broad variety of design and orchestration of cloud and cloud native platforms, tools, and technologies. +- [Providers]({{< ref "reference/extensibility/providers/index.md" >}}): for connecting to different cloud providers and infrastructure platforms +- [UI Plugins]({{< ref "reference/extensibility/ui.md" >}}): Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins. \ No newline at end of file diff --git a/docs/content/en/guides/configuration-management/creating-a-meshery-design/index.md b/docs/content/en/guides/configuration-management/creating-a-meshery-design.md similarity index 84% rename from docs/content/en/guides/configuration-management/creating-a-meshery-design/index.md rename to docs/content/en/guides/configuration-management/creating-a-meshery-design.md index 09e35406758ac..34ae343885bec 100644 --- a/docs/content/en/guides/configuration-management/creating-a-meshery-design/index.md +++ b/docs/content/en/guides/configuration-management/creating-a-meshery-design.md @@ -9,7 +9,7 @@ aliases: A Meshery Design is the primary unit of configuration management in Meshery. It is a declarative document that describes the desired state of your infrastructure and applications β€” the components you want, their configuration, and their relationships. Designs can be deployed, shared, versioned, exported, and imported. -See [Meshery Designs](/concepts/logical/designs) for a full description of design capabilities. +See [Meshery Designs]({{< ref "concepts/logical/designs.md" >}}) for a full description of design capabilities. ## Ways to Create a Design @@ -103,7 +103,7 @@ mesheryctl design apply MyDesignName mesheryctl design list ``` -See the [`mesheryctl design` reference](/reference/mesheryctl/design) for the full subcommand reference. +See the [`mesheryctl design` reference]({{< ref "reference/mesheryctl/design/_index.md" >}}) for the full subcommand reference. --- @@ -111,18 +111,18 @@ See the [`mesheryctl design` reference](/reference/mesheryctl/design) for the fu When you start Meshery for the first time, a set of seed designs is available. These cover common Kubernetes patterns and serve as a starting point for exploration. -Seed designs in Meshery UI +Seed designs in Meshery UI You can also import community designs from the [Meshery Catalog](https://meshery.io/catalog) or from a Git repository. -Importing a design in Meshery UI +Importing a design in Meshery UI --- ## Related -- [Meshery Designs concept](/concepts/logical/designs) -- [Importing Designs](/guides/configuration-management/importing-models) -- [Deploying a Design](/guides/configuration-management/working-with-designs) -- [`mesheryctl design` reference](/reference/mesheryctl/design) +- [Meshery Designs concept]({{< ref "concepts/logical/designs.md" >}}) +- [Importing Designs]({{< ref "guides/configuration-management/importing-models/index.md" >}}) +- [Deploying a Design]({{< ref "guides/configuration-management/working-with-designs/index.md" >}}) +- [`mesheryctl design` reference]({{< ref "reference/mesheryctl/design/_index.md" >}}) - [Meshery Catalog](https://meshery.io/catalog) diff --git a/docs/content/en/guides/configuration-management/creating-models/index.md b/docs/content/en/guides/configuration-management/creating-models/index.md index 43b01f5a068ab..308c746b40508 100644 --- a/docs/content/en/guides/configuration-management/creating-models/index.md +++ b/docs/content/en/guides/configuration-management/creating-models/index.md @@ -6,14 +6,14 @@ aliases: categories: [configuration] --- -Meshery offers two primary ways to bring models into your system: **Create** and **[Import](/guides/configuration-management/importing-models)**. +Meshery offers two primary ways to bring models into your system: **Create** and **[Import]({{< ref "guides/configuration-management/importing-models/index.md" >}})**. - **Import** is ideal when you already have a model definition file (e.g., JSON, CSV) and simply want to bring it into Meshery. - **Create** is the recommended approach if you’re starting fresh β€” it guides you through building a model step by step using an intuitive UI wizard. This section walks you through the **Create** workflow β€” perfect for users who want full control over naming, styling, and categorizing their models while sourcing CRDs from GitHub or ArtifactHub. -> Tip: If you don’t have any files yet, start with **Create**. You can always [export](/guides/configuration-management/exporting-models) or re-import your model later. +> Tip: If you don’t have any files yet, start with **Create**. You can always [export]({{< ref "guides/configuration-management/exporting-models/index.md" >}}) or re-import your model later. {{< tabs id="creating-models-tabs" >}} Meshery UI | fa fa-desktop @@ -109,7 +109,7 @@ When a model is marked for visual annotation only, it means the model will be us

                        Step 8: Check Model Generation Status

                        Once the model is successfully generated, a confirmation message will appear. You'll be able to view the model along with its components and relationships directly in the Registry page.

                        If any issues occur, Meshery will display an error message detailing what went wrong so you can correct it and try again.

                        -

                        A notification will also appear in the Notification Center to confirm whether the operation succeeded or failed, providing additional context if needed.

                        +

                        A notification will also appear in the }}">Notification Center to confirm whether the operation succeeded or failed, providing additional context if needed.

                        {{% alert color="warning" title="Note on Deletion" %}} Once a model is generated, it cannot be deleted from the Meshery UI. If you no longer wish to use it, you may mark it as ignored instead. @@ -121,7 +121,7 @@ mesheryctl | fa fa-terminal

                        Prerequisites:

                        {{% alert color="info" title="Generating Models does not require Meshery Server" %}} diff --git a/docs/content/en/guides/configuration-management/edges-guide/index.md b/docs/content/en/guides/configuration-management/edges-guide.md similarity index 89% rename from docs/content/en/guides/configuration-management/edges-guide/index.md rename to docs/content/en/guides/configuration-management/edges-guide.md index aa722b3825eb7..34ecc811a13ce 100644 --- a/docs/content/en/guides/configuration-management/edges-guide/index.md +++ b/docs/content/en/guides/configuration-management/edges-guide.md @@ -7,7 +7,7 @@ aliases: - /extensions/edges-shape-guide/ --- -In Meshery, the line that connects [components](/concepts/logical/components) is called an **edge**. Each edge visually represents a [relationship](/concepts/logical/relationships) and uses a specific style to communicate its nature. +In Meshery, the line that connects [components]({{< ref "concepts/logical/components.md" >}}) is called an **edge**. Each edge visually represents a [relationship]({{< ref "concepts/logical/relationships/index.md" >}}) and uses a specific style to communicate its nature. This guide helps you interpret the most common edge styles you will encounter. diff --git a/docs/content/en/guides/configuration-management/exporting-models/index.md b/docs/content/en/guides/configuration-management/exporting-models/index.md index 98599fff794cb..99025943a05d0 100644 --- a/docs/content/en/guides/configuration-management/exporting-models/index.md +++ b/docs/content/en/guides/configuration-management/exporting-models/index.md @@ -4,17 +4,17 @@ description: Exporting Meshery Model as an OCI or Compress file categories: [configuration] --- -Export existing Meshery [Models](/concepts/logical/models) or your custom infrastructure crd imported as [Models](/concepts/logical/models) in Meshery. The platform supports a variety of application definition formats, and you can export designs using either the Meshery CLI or the Meshery UI. +Export existing Meshery [Models]({{< ref "concepts/logical/models/index.md" >}}) or your custom infrastructure crd imported as [Models]({{< ref "concepts/logical/models/index.md" >}}) in Meshery. The platform supports a variety of application definition formats, and you can export designs using either the Meshery CLI or the Meshery UI. ## Export Models Using Meshery CLI **Step 1: Install Meshery CLI** -Before you can use the Meshery CLI to export a [Model](/concepts/logical/models), you must first install it. You can install Meshery CLI by [following the instructions](/installation#install-mesheryctl). +Before you can use the Meshery CLI to export a [Model]({{< ref "concepts/logical/models/index.md" >}}), you must first install it. You can install Meshery CLI by [following the instructions]({{< ref "installation/_index.md#install-mesheryctl" >}}). **Step 2: Export the Model** -Model can be exported in 2 format and OCI or Compress file. These files contain different [components](/concepts/logical/components), [relationships](/concepts/logical/relationships) files and a model file. The files can be exported in either yaml or json by default it is exported as yaml. +Model can be exported in 2 format and OCI or Compress file. These files contain different [components]({{< ref "concepts/logical/components.md" >}}), [relationships]({{< ref "concepts/logical/relationships/index.md" >}}) files and a model file. The files can be exported in either yaml or json by default it is exported as yaml. 
                         
                        mesheryctl model export [model-name] 
                        
@@ -32,13 +32,13 @@ Different file type and output type can be set using flags `-o` for oci and tar
 
                        mesheryctl model export istio-base -o oci -t json
                        -**Note:** A `--discard-components --discard-relationships` flag is present to skip [component](/concepts/logical/components) and [relationships](/concepts/logical/relationships) generation in the export only the model is exported without any components and relationships. +**Note:** A `--discard-components --discard-relationships` flag is present to skip [component]({{< ref "concepts/logical/components.md" >}}) and [relationships]({{< ref "concepts/logical/relationships/index.md" >}}) generation in the export only the model is exported without any components and relationships. ## Export Models Using Meshery UI **Step 1: Access the Meshery UI** -To Export a model into Meshery using the Meshery UI, you must first [install Meshery](/installation/quick-start) +To Export a model into Meshery using the Meshery UI, you must first [install Meshery]({{< ref "installation/quick-start/index.md" >}}) **Step 2: Navigate to Registry under Settings Page** @@ -54,4 +54,4 @@ This Meshery model will include components, relationships. Export-Model -Once the Meshery model has been exported, you can export your model anytime back using `Import` on UI and then visualize in Meshery, operate and observe your components that are geneated from the crd. You can also use Meshery to deploy your Meshery Model in form of a design to any of your connected kubernetes clusters. For more information, see [connections](/installation/kubernetes) +Once the Meshery model has been exported, you can export your model anytime back using `Import` on UI and then visualize in Meshery, operate and observe your components that are geneated from the crd. You can also use Meshery to deploy your Meshery Model in form of a design to any of your connected kubernetes clusters. For more information, see [connections]({{< ref "installation/kubernetes/_index.md" >}}) diff --git a/docs/content/en/guides/configuration-management/identifying-components/index.md b/docs/content/en/guides/configuration-management/identifying-components/index.md index bb598b4460c6c..ccfb9ba422344 100644 --- a/docs/content/en/guides/configuration-management/identifying-components/index.md +++ b/docs/content/en/guides/configuration-management/identifying-components/index.md @@ -8,7 +8,7 @@ aliases: Ever wondered what the different icons and shapes in Meshery represent? Whether you're looking at a dashboard, a settings page, or a design, you'll encounter a rich library of visual elements. This guide is here to help you understand what they mean. -The [components](/concepts/logical/components) in Meshery fall into two fundamental categories, distinguished by whether they can be orchestrated (managed) by Meshery during deployment: +The [components]({{< ref "concepts/logical/components.md" >}}) in Meshery fall into two fundamental categories, distinguished by whether they can be orchestrated (managed) by Meshery during deployment: - **Semantic Components (Orchestratable):** These represent actual infrastructure resources that Meshery can understand and manage during deployment. Examples include Kubernetes resources (like Pods and Services), databases, and other infrastructure components. Meshery will actively manage their lifecycle during deployment. @@ -20,7 +20,7 @@ All components, whether semantic or non-semantic, support rich visual customizat ## Semantic Components -These components represent real infrastructure that Meshery can manage. They can be either built-in (like Kubernetes components) or custom components that you [create](/guides/configuration-management/creating-models). +These components represent real infrastructure that Meshery can manage. They can be either built-in (like Kubernetes components) or custom components that you [create]({{< ref "guides/configuration-management/creating-models/index.md" >}}). ### Kubernetes Components @@ -43,7 +43,7 @@ Meshery supports various technologies (like AWS, Prometheus, Istio, KEDA, etc.) {{% alert color="info" title="Exploring All Integrations" %}} -This guide covers the visual style of components. For a complete catalog of all technologies that Meshery integrates, visit the integrations directory. Explore All Integrations +This guide covers the visual style of components. For a complete catalog of all technologies that Meshery integrates, visit the integrations directory. Explore All Integrations {{% /alert %}} ## Non-semantic Components @@ -58,7 +58,7 @@ These components help you document and organize your designs without affecting t While these components are ignored during deployment, they support the same visual customization options as semantic components. {{% alert color="info" title="Edge Components" %}} -To learn more about edge components and their visual styles, visit the Edge Components Guide +To learn more about edge components and their visual styles, visit the Edge Components Guide {{% /alert %}} ## Foundational Elements diff --git a/docs/content/en/guides/configuration-management/working-with-designs/images/meshery-patterns.png b/docs/content/en/guides/configuration-management/images/meshery-patterns.png similarity index 100% rename from docs/content/en/guides/configuration-management/working-with-designs/images/meshery-patterns.png rename to docs/content/en/guides/configuration-management/images/meshery-patterns.png diff --git a/docs/content/en/guides/configuration-management/working-with-designs/images/pattern-import.png b/docs/content/en/guides/configuration-management/images/pattern-import.png similarity index 100% rename from docs/content/en/guides/configuration-management/working-with-designs/images/pattern-import.png rename to docs/content/en/guides/configuration-management/images/pattern-import.png diff --git a/docs/content/en/guides/configuration-management/import-export-a-design/import-export-designs.md b/docs/content/en/guides/configuration-management/import-export-designs.md similarity index 87% rename from docs/content/en/guides/configuration-management/import-export-a-design/import-export-designs.md rename to docs/content/en/guides/configuration-management/import-export-designs.md index 6bb37642a797d..bbe9c37d92bd5 100644 --- a/docs/content/en/guides/configuration-management/import-export-a-design/import-export-designs.md +++ b/docs/content/en/guides/configuration-management/import-export-designs.md @@ -3,6 +3,7 @@ title: Importing and Exporting Designs description: Manage and transfer Meshery designs seamlessly through import and export using CLI and UI. aliases: - /guides/configuration-management/importing-designs +- /guides/configuration-management/import-export-a-design/import-export-designs - /extensions/importing-a-design - /extensions/importing-an-application display_title: false @@ -11,9 +12,9 @@ display_title: false # Importing and Exporting Designs Meshery supports two primary operations for working with designs: **Import** and **Export**. -A **[design](/concepts/logical/designs)** in Meshery is a structured model describing how various components (e.g., Kubernetes manifests, Helm charts, or Docker Compose objects) should be managed and deployed. This document details the core concepts, the import/export processes, and the available methods to perform them. +A **[design]({{< ref "concepts/logical/designs.md" >}})** in Meshery is a structured model describing how various components (e.g., Kubernetes manifests, Helm charts, or Docker Compose objects) should be managed and deployed. This document details the core concepts, the import/export processes, and the available methods to perform them. -As a refresher, [designs](/concepts/logical/designs) consist of: +As a refresher, [designs]({{< ref "concepts/logical/designs.md" >}}) consist of: - **Components**: Defined resources or services (e.g., Deployments, Services). - **Relationships**: Possible connections or dependencies among components (e.g., hierarchical, sibling, edge). @@ -35,7 +36,7 @@ When **exporting** a design, Meshery: ## Import Methods -You can import designs into Meshery through either **[Meshery CLI](/reference/mesheryctl)** or **Meshery UI**. +You can import designs into Meshery through either **[Meshery CLI]({{< ref "reference/mesheryctl/_index.md" >}})** or **Meshery UI**. ### 1. Using Meshery CLI diff --git a/docs/content/en/guides/configuration-management/importing-models/index.md b/docs/content/en/guides/configuration-management/importing-models/index.md index 14a9d5d28aaa9..f5880dd75ad34 100644 --- a/docs/content/en/guides/configuration-management/importing-models/index.md +++ b/docs/content/en/guides/configuration-management/importing-models/index.md @@ -6,7 +6,7 @@ categories: [configuration] Import your existing Models and existing custom resource definition (CRD) into Meshery. The platform supports a variety of application definition formats, and you can import designs using either the Meshery CLI or the Meshery UI. -**Note:** A [Model](/concepts/logical/models) can be only imported if it contains atleast a valid [Component](/concepts/logical/components) or [Relationship](/concepts/logical/relationships). +**Note:** A [Model]({{< ref "concepts/logical/models/index.md" >}}) can be only imported if it contains atleast a valid [Component]({{< ref "concepts/logical/components.md" >}}) or [Relationship]({{< ref "concepts/logical/relationships/index.md" >}}). ## Import Models Using Meshery CLI @@ -16,7 +16,7 @@ The `mesheryctl model import` command currently supports importing Models contai **Step 1: Install Meshery CLI** -Before you can use the Meshery CLI to import a [Model](/concepts/logical/models), you must first install it. You can install Meshery CLI by [following the instructions](/installation#install-mesheryctl). +Before you can use the Meshery CLI to import a [Model]({{< ref "concepts/logical/models/index.md" >}}), you must first install it. You can install Meshery CLI by [following the instructions]({{< ref "installation/_index.md#install-mesheryctl" >}}). **Step 2: Import the Model** @@ -48,7 +48,7 @@ https://github.com/{owner}/{repo}/raw/refs/heads/main/filename **Step 1: Access the Meshery UI** -To import a model into Meshery using the Meshery UI, you must first [install Meshery](/installation/quick-start) +To import a model into Meshery using the Meshery UI, you must first [install Meshery]({{< ref "installation/quick-start/index.md" >}}) **Step 2: Navigate to Registry under Settings Page** diff --git a/docs/content/en/guides/configuration-management/pattern-management/index.md b/docs/content/en/guides/configuration-management/pattern-management/index.md index a44713b466f31..a33ee9fc56d28 100644 --- a/docs/content/en/guides/configuration-management/pattern-management/index.md +++ b/docs/content/en/guides/configuration-management/pattern-management/index.md @@ -14,7 +14,7 @@ Patterns are essentially atomic designs with one or more components made in comp ## Use Meshery to Deploy a Cloud Native Pattern -Use Meshery to deploy a cloud native pattern. Cloud native patterns are detailed as a YAML file. See the [Configuration Management](/guides/configuration-management) guide. +Use Meshery to deploy a cloud native pattern. Cloud native patterns are detailed as a YAML file. See the [Configuration Management]({{< ref "guides/configuration-management/_index.md" >}}) guide. ### Pattern Repository @@ -23,7 +23,7 @@ _See [Meshery Catalog](https://meshery.io/catalog)_. You may bring your own patterns or find them available through your chosen provider. Each cloud native pattern carries a unique identifier for reference. The patterns in this repository serve in an educational capacity, facilitating learning, and also serve in an operational capacity, facilitating implementation and validation of your cloud native deployment’s adherence to a pattern. {{% alert color="info" title="Repository of Cloud Native Patterns" %}} -A central set of design patterns is available in Meshery Catalog (concept, site). +A central set of design patterns is available in Meshery Catalog (concept, site). {{% /alert %}} @@ -78,4 +78,4 @@ Deployed. Endpoint(s) available at: http://localhost:8000/catalog ## Related Reading -- [`mesheryctl design`](/reference/mesheryctl/design) +- [`mesheryctl design`]({{< ref "reference/mesheryctl/design/_index.md" >}}) diff --git a/docs/content/en/guides/configuration-management/push-pull-model-image/index.md b/docs/content/en/guides/configuration-management/push-pull-model-image.md similarity index 100% rename from docs/content/en/guides/configuration-management/push-pull-model-image/index.md rename to docs/content/en/guides/configuration-management/push-pull-model-image.md diff --git a/docs/content/en/guides/configuration-management/working-with-designs/index.md b/docs/content/en/guides/configuration-management/working-with-designs/index.md index 46784f44e2f6f..045c5483c8177 100644 --- a/docs/content/en/guides/configuration-management/working-with-designs/index.md +++ b/docs/content/en/guides/configuration-management/working-with-designs/index.md @@ -17,17 +17,17 @@ Meshery's core construct of configuration management is that of a design. A desi You are free to choose how you would like to create an infrastructure design. You can use the **Design Configurator** built into Meshery UI, or you can hand-code your design using the Meshery schema spec. -See [Creating a Meshery Design](/guides/configuration-management/creating-a-meshery-design) for a step-by-step walkthrough. Use Meshery UI or `mesheryctl` to create and manage designs. +See [Creating a Meshery Design]({{< ref "guides/configuration-management/creating-a-meshery-design.md" >}}) for a step-by-step walkthrough. Use Meshery UI or `mesheryctl` to create and manage designs. ## Pattern Management Through Meshery UI Meshery also comes with seed patterns when users start Meshery for the first time. These patterns cover common use cases and examples for you as you explore Meshery. - + Users can also import these patterns to their remote provider from this [sample repository](https://github.com/service-mesh-patterns/service-mesh-patterns/tree/master/samples). - + Once these patterns are imported, you can then edit these patterns or use the pattern configurator to configure them according to your requirements. @@ -55,7 +55,7 @@ mesheryctl design apply BookInfoApp This will apply the pattern BookInfoApp, which has already been imported into Meshery. -See [mesheryctl design subcommand section](/reference/mesheryctl/#cloud-native-pattern-configuration-and-management) for more details on the `design` subcommand. +See [mesheryctl design subcommand section]({{< ref "reference/mesheryctl/_index.md#cloud-native-pattern-configuration-and-management" >}}) for more details on the `design` subcommand. ## WASM Filters @@ -69,7 +69,7 @@ Like patterns, Meshery also comes with some sample WebAssembly Filters for you t You can also import these filters manually to your provider from the [wasm-filters](https://github.com/meshery-extensions/wasm-filters) repo. -Meshery's sample application [ImageHub](/guides/infrastructure-management/sample-apps) will let you test out configuring these filters out-of-the-box. +Meshery's sample application [ImageHub]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) will let you test out configuring these filters out-of-the-box. You can onboard ImageHub to an installed service mesh as shown below. diff --git a/docs/content/en/guides/infrastructure-management/filter-management/index.md b/docs/content/en/guides/infrastructure-management/filter-management.md similarity index 100% rename from docs/content/en/guides/infrastructure-management/filter-management/index.md rename to docs/content/en/guides/infrastructure-management/filter-management.md diff --git a/docs/content/en/guides/infrastructure-management/gitops-with-meshery/index.md b/docs/content/en/guides/infrastructure-management/gitops-with-meshery/index.md index b189b5fca9b14..98bee9b8218b5 100644 --- a/docs/content/en/guides/infrastructure-management/gitops-with-meshery/index.md +++ b/docs/content/en/guides/infrastructure-management/gitops-with-meshery/index.md @@ -13,7 +13,7 @@ categories: [infrastructure]

                        Using Meshery's SnapShot GitHub Action

                        See your deployment before you merge. Connect Meshery to your GitHub repo and see changes pull request-to-pull request. Get snapshots of your infrastructure directly in your PRs. -See [Extension: Meshery Snapshot](/extensions/snapshot) for more details. +See [Extension: Meshery Snapshot]({{< ref "extensions/helm-snapshot/index.md" >}}) for more details. ## Infrastructure fperformance logo Meshery Performance Analysis GitHub Action @@ -90,6 +90,6 @@ See this sample GitHub workflow (performance management dashboard -The results from the tests are updated on the Performance Management dashboard in Meshery. To learn more about interpreting the test results, check out this guide. You can always checkout the Meshery User Guides to dive deep into these features. +The results from the tests are updated on the Performance Management dashboard in Meshery. To learn more about interpreting the test results, check out }}">this guide. You can always checkout the }}">Meshery User Guides to dive deep into these features. -Cloud Native Performance standardizes infrastructure measurement, characterizing any deployment's performance by capturing the details of infrastructure capacity, configuration and workload metadata. \ No newline at end of file +Cloud Native Performance standardizes infrastructure measurement, characterizing any deployment's performance by capturing the details of infrastructure capacity, configuration and workload metadata. diff --git a/docs/content/en/guides/infrastructure-management/lifecycle-management/index.md b/docs/content/en/guides/infrastructure-management/lifecycle-management/index.md index e53d965a572ce..182a8e8ee3424 100644 --- a/docs/content/en/guides/infrastructure-management/lifecycle-management/index.md +++ b/docs/content/en/guides/infrastructure-management/lifecycle-management/index.md @@ -9,7 +9,7 @@ description: Manage the lifecycle of your infrastructure by registering each inf -Meshery manages hundreds of different types of cloud native infrastructure. See the [full set of integrations](/extensibility/integrations). +Meshery manages hundreds of different types of cloud native infrastructure. See the [full set of integrations]({{< ref "extensions/models/_index.md" >}}). ## Cloud Native Infrastructure Lifecycle Management @@ -29,7 +29,7 @@ Just as Meshery automates the provisioning of various cloud native infrastructur Users may bring their applications (perform workload onboarding) on the infrastructure using the Custom Configuration operation. -Commonly adjoining each infrastructure is a sample application that facilitates demonstration of the value of the given infrastructure. Meshery allows you to efficiently [install sample applications](/guides/infrastructure-management/sample-apps) across different infrastructurees. +Commonly adjoining each infrastructure is a sample application that facilitates demonstration of the value of the given infrastructure. Meshery allows you to efficiently [install sample applications]({{< ref "guides/infrastructure-management/sample-apps/index.md" >}}) across different infrastructurees. ## Configuration Management @@ -41,7 +41,7 @@ Meshery tracks operations that you perform on infrastructurees and their workloa #### Acknowledging and dismissing notifications -Depending upon the severity of the notification, many notifications are informational and can readily be dismissed after reading. Some notifications include actionable alerts. Learn more in "[Managing Events with Notification Center](/guides/infrastructure-management/notification-management)". +Depending upon the severity of the notification, many notifications are informational and can readily be dismissed after reading. Some notifications include actionable alerts. Learn more in "[Managing Events with Notification Center]({{< ref "guides/infrastructure-management/notification-management/index.md" >}})". ## Lifecycle FAQs @@ -54,7 +54,7 @@ Depending upon the severity of the notification, many notifications are informat

                        3. Connectivity: those individuals will have to be afforded network connectivity to that cluster (in whatever fashion you deem appropriate). Grossly, there are two ways in which this can occur:

                        3.a) The other user runs their own copy of Meshery (or signs into a shared instance like the Playground) and will see the connection as being available when they sign in. Their Meshery Server will need to be able to reach your Kube API over the network. How that is done can be any number of ways and is left unto your own devices.

                        3.b.) The other user signs into your Meshery Server instance, which has network access to your Kubernetes cluster. In order for the other user to sign into your Meshery Server, you would have to expose it to the Internet or VPN or… one of the many other ways to all them access to your Meshery Server.

                        -

                        So, in short, yes, you can share access to your Kubernetes cluster with other users, but you have to explicitly grant them access to do so. For more information please visit Remote Provider Permissions.

                        +

                        So, in short, yes, you can share access to your Kubernetes cluster with other users, but you have to explicitly grant them access to do so. For more information please visit }}">Remote Provider Permissions.

                      {{< discuss >}} \ No newline at end of file diff --git a/docs/content/en/guides/infrastructure-management/overview/index.md b/docs/content/en/guides/infrastructure-management/overview.md similarity index 90% rename from docs/content/en/guides/infrastructure-management/overview/index.md rename to docs/content/en/guides/infrastructure-management/overview.md index 3e9111eaf6814..6ce7b40c7bb71 100644 --- a/docs/content/en/guides/infrastructure-management/overview/index.md +++ b/docs/content/en/guides/infrastructure-management/overview.md @@ -13,7 +13,7 @@ Meshery is a versatile platform designed to streamline the lifecycle, configurat ### Designs in Meshery -Meshery employs the concept of [Designs](/concepts/logical/designs) as a fundamental construct for managing infrastructure. Designs provide a structured way to organize and deploy various components of your infrastructure. To do so, Meshery utilizes a declarative approach to infrastructure management, similar to Kubernetes manifests. Meshery Designs are written in YAML and are validated against a schema. +Meshery employs the concept of [Designs]({{< ref "concepts/logical/designs.md" >}}) as a fundamental construct for managing infrastructure. Designs provide a structured way to organize and deploy various components of your infrastructure. To do so, Meshery utilizes a declarative approach to infrastructure management, similar to Kubernetes manifests. Meshery Designs are written in YAML and are validated against a schema. #### Importing Existing Infrastructure and Applications @@ -25,7 +25,7 @@ Meshery facilitates the import of infrastructure in multiple formats, including - Docker Compose -See [Importing Designs](/extensions/import-export-designs) for more information. +See [Importing Designs]({{< ref "guides/configuration-management/import-export-designs.md" >}}) for more information.
                      @@ -87,4 +87,4 @@ This logic is handled in the NewDependencyHandler() function, which {{% alert color="info" title="Upcoming Features" %}}

                      Meshery is actively developing the ability to import custom models and components, expanding the platform's flexibility. Support for OCI registries is expected in the near future.

                      1. Custom Models and Components: Import your own models for more flexibility.

                      2. OCI Registry Support: In addition to ArtifactHub, OCI registries will be supported soon.

                      -{{% /alert %}} \ No newline at end of file +{{% /alert %}} diff --git a/docs/content/en/guides/infrastructure-management/registering-a-connection/index.md b/docs/content/en/guides/infrastructure-management/registering-a-connection.md similarity index 90% rename from docs/content/en/guides/infrastructure-management/registering-a-connection/index.md rename to docs/content/en/guides/infrastructure-management/registering-a-connection.md index 32fc1131d2a51..155982cd23a1f 100644 --- a/docs/content/en/guides/infrastructure-management/registering-a-connection/index.md +++ b/docs/content/en/guides/infrastructure-management/registering-a-connection.md @@ -5,7 +5,7 @@ description: MeshSync supports both greenfield and brownfield discovery of infra --- {{% alert color="info" title="MeshSync" %}} -Managed by the Meshery Operator, MeshSync is a custom Kubernetes controller that provides tiered discovery and continual synchronization with Meshery Server as to the state of the Kubernetes clusters and their workloads. Learn more about MeshSync. +Managed by the Meshery Operator, MeshSync is a custom Kubernetes controller that provides tiered discovery and continual synchronization with Meshery Server as to the state of the Kubernetes clusters and their workloads. Learn more about MeshSync. {{% /alert %}} MeshSync is your tool for efficient management and synchronization of Kubernetes clusters! This user guide will walk you through how to establish a connection with any element that Meshery is able to connect to and manage. Use the MeshSync page to register connections, view connection metadata, and perform connectivity tests, as weel as to manage credentials and environments. diff --git a/docs/content/en/guides/mesheryctl/images/create-token.png b/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/create-token.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/create-token.png rename to docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/create-token.png diff --git a/docs/content/en/guides/mesheryctl/images/download-token.png b/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/download-token.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/download-token.png rename to docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/download-token.png diff --git a/docs/content/en/guides/mesheryctl/images/generate-token.png b/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/generate-token.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/generate-token.png rename to docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/images/generate-token.png diff --git a/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli.md b/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/index.md similarity index 74% rename from docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli.md rename to docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/index.md index 0dbf071e1e376..1faca89f92d6d 100644 --- a/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli.md +++ b/docs/content/en/guides/mesheryctl/authenticate-with-meshery-via-cli/index.md @@ -27,7 +27,7 @@ Use the arrow keys to navigate: ↓ ↑ β†’ ← -rw-rw-r-- 1 ubuntu ubuntu 988 Dec 21 06:04 meshery.yaml ``` - **_The need for authentication to `Meshery` [provider](/extensibility/providers) is to save your environment setup while also having persistent/steady sessions and to be able to retrieve performance test results._** + **_The need for authentication to `Meshery` [provider]({{< ref "reference/extensibility/providers/index.md" >}}) is to save your environment setup while also having persistent/steady sessions and to be able to retrieve performance test results._** - Selecting _None_ will create an empty `auth.json` file. All your work remains local and ephemeral. @@ -36,19 +36,19 @@ If `mesheryctl` is running in a system that does not have a browser, you can dow 1. Navigate to [https://cloud.meshery.io/security/tokens](https://cloud.meshery.io/security/tokens) and sign-in. Ensure you are in the right organization and click **Create**. -Create Token +Create Token 2. Provide a token name and purpose. Click **Create** to generate. - Generate Token + Generate Token 3. Click the **Download** icon to download the `auth.json` file. - Download Token + Download Token Then run `mesheryctl system check` to ensure you do not see an authentication error. -For an exhaustive list of `mesheryctl` commands and syntax, visit [`mesheryctl` Command Reference](/reference/mesheryctl). +For an exhaustive list of `mesheryctl` commands and syntax, visit [`mesheryctl` Command Reference]({{< ref "reference/mesheryctl/_index.md" >}}). {{< related-discussions tag="mesheryctl" >}} diff --git a/docs/content/en/guides/mesheryctl/configuring-autocompletion-for-mesheryctl.md b/docs/content/en/guides/mesheryctl/configuring-autocompletion-for-mesheryctl.md index 51e3fe38793c3..d554007e16fab 100644 --- a/docs/content/en/guides/mesheryctl/configuring-autocompletion-for-mesheryctl.md +++ b/docs/content/en/guides/mesheryctl/configuring-autocompletion-for-mesheryctl.md @@ -68,7 +68,7 @@ To load fish shell completions for each session, execute once: For an exhaustive list of `mesheryctl` commands and syntax: -- See [`mesheryctl` Command Reference](/reference/mesheryctl). +- See [`mesheryctl` Command Reference]({{< ref "reference/mesheryctl/_index.md" >}}). Guides to using Meshery's various features and components. diff --git a/docs/content/en/guides/mesheryctl/running-system-checks-using-mesheryctl.md b/docs/content/en/guides/mesheryctl/running-system-checks-using-mesheryctl.md index 583c7b5b9ca58..4a32531600933 100644 --- a/docs/content/en/guides/mesheryctl/running-system-checks-using-mesheryctl.md +++ b/docs/content/en/guides/mesheryctl/running-system-checks-using-mesheryctl.md @@ -87,11 +87,11 @@ Users can also narrow down the tests to just check the status of the Meshery ope ##### Question: I ran a preflight check to see if I satisfy all requirements for Meshery in my system. It returned positive results but I couldn't start Meshery. What to do? -**Answer**: _Make sure if you've configured your system to run Meshery in smooth manner. For configuration, do check out the docs site and [this page](/installation) to see instructions related to the platform you use._ +**Answer**: _Make sure if you've configured your system to run Meshery in smooth manner. For configuration, do check out the docs site and [this page]({{< ref "installation/_index.md" >}}) to see instructions related to the platform you use._ ##### Question: Do I need a Kubernetes cluster or will a Docker host suffice for Meshery deployments? -**Answer**: _Meshery's [performance management](/guides/performance-management/managing-performance) functionality does not require a Kubernetes cluster. The rest of Meshery's functionality (e.g. cloud native management) does require a Kubernetes cluster._ +**Answer**: _Meshery's [performance management]({{< ref "guides/performance-management/managing-performance/index.md" >}}) functionality does not require a Kubernetes cluster. The rest of Meshery's functionality (e.g. cloud native management) does require a Kubernetes cluster._ ##### Question: What are Meshery's production deployment requirements? @@ -133,7 +133,7 @@ Users can also narrow down the tests to just check the status of the Meshery ope For an exhaustive list of `mesheryctl` commands and syntax: -- See [`mesheryctl` Command Reference](/reference/mesheryctl). +- See [`mesheryctl` Command Reference]({{< ref "reference/mesheryctl/_index.md" >}}). Guides to using Meshery's various features and components. diff --git a/docs/content/en/guides/mesheryctl/system-commands.md b/docs/content/en/guides/mesheryctl/system-commands.md deleted file mode 100644 index f47817f9a34d3..0000000000000 --- a/docs/content/en/guides/mesheryctl/system-commands.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: Mesheryctl system commands -categories: [mesheryctl] -description: Mesheryctl system commands for managing Meshery deployments. ---- - -Let's get familiar with mesheryctl system commands. The syntax of the mesheryctl commands goes as follws : `mesheryctl ` - -## Main_command : system -### start -`mesheryctl system start` : This will initiate Meshery & automatically open it in your default web browser. - -skip-browser - -`mesheryctl system start --skip-browser` : It skips opening Meshery in your browser with the provided URL. - -skip-browser - -`mesheryctl system start --skip-update` : It is used when you want to skip updating Meshery if an update is available. - -skip-browser - -`mesheryctl system start --reset` : It resets your Meshery configuration file to its default configuration. - -`mesheryctl system start --platform string` : It allows you specify a platform for deploying Meshery. - -skip-browser - - -### stop -`mesheryctl system stop` : It stops Meshery resources & delete its associated namespaces. - -skip-browser - -`mesheryctl system stop --reset` : It stops Meshery and resets the Meshery configuration file to its default configuration. - -skip-browser - -`mesheryctl system stop --keep-namespace` : It stops Meshery without deleting the associated namespaces. - -skip-browser - -`mesheryctl system stop --force` : Force stops Meshery instead of gentle way. This is only used in emergency situations when `mesheryctl system stop` can't halt Meshery. - -skip-browser - -### update -`mesheryctl system update` : This updates Meshery itself, not the mesheryctl. Ensure Meshery is running when using this. - -skip-browser - -`mesheryctl system update --skip-reset` : Skips the check for a new manifest file. - -skip-browser - -### reset -`mesheryctl system reset` : Resets Meshery to its default configuration. - -skip-browser - -### restart -`meshryctl system restart` : Stops Meshery and then starts it again. Opens the website in your default browser. - -skip-browser - -### status -`mesheryctl system status` : Displays the status of Meshery components. - -`mesheryctl system status --verbose` : Provides additional data along with Meshery and its component status. - -skip-browser - - -### dashboard -`mesheryctl system dashboard` : Opens the Meshery dashboard in your default browser. - -skip-browser - -`mesheryctl system dashboard --skip-browser` : Provides the link to the dashboard, allowing you to open it in any browser. - -skip-browser - -`mesheryctl system dashboard --port-forward` : If the current port is busy, it opens the dashboard on another port. - -skip-browser - - -### login -`mesheryctl system login` : Authenticates you with your selected provider. - -skip-browser - -### check -`mesheryctl system check` : Performs checks for both pre & post mesh deployment scenarios on Meshery. - -skip-browser - -`mesheryctl system check --preflight` : Runs pre-deployment checks. - -`mesheryctl system check --adapter` : Runs checks for a specific Mesh adapter. - -`mesheryctl system check --adapters` : Runs checks for Meshery adapters - -`mesheryctl system check --components` : Runs checks for Meshery components - -`mesheryctl system check --operator` : Runs checks for Meshery Operator - -## Main_command : system channel -### channel -`mesheryctl system channel set [stable|stable-version|edge|edge-version]` : Used to set the channel. - -`mesheryctl system channel switch [stable|stable-version|edge|edge-version]` : Used to switch between channels. - -skip-browser - -`mesheryctl system channel view --all` : Displays all available channels. - -`mesheryctl system channel view` : Displays the current channel. - -skip-browser - - -## Main_command : system context -### create -`mesheryctl system context create 'context-name'` : Creates a new context with default parameters. - -skip-browser - -`mesheryctl system context create --component stringArray` : Specifies the component to be created in the context. - -`mesheryctl system context create --platform string` : Specifies the platform. - -`mesheryctl system context create --set` : Sets this context as default context. - -`mesheryctl system context create --url string` : Specifies the target URL. - -skip-browser - - -### switch -`mesheryctl system context switch` : Easily switch between different contexts. - -### list -`mesheryctl system context list` : Lists all your available Meshery contexts. - -skip-browser - -### delete -`mesheryctl system context delete` : Delete context. - -skip-browser - - -### view -`mesheryctl system context view` : Display all your contexts with additional information. - -skip-browser - - -## Main_command : system provider -### switch -`mesheryctl system provider switch` : Changes your provider - -skip-browser - -### list -`mesheryctl system provider list` : Lists all available providers - -skip-browser - -### set -`mesheryctl system provider set` : Set your provider - -skip-browser - -### view -`mesheryctl system provider view` : Lists your current context and provider - -skip-browser - diff --git a/docs/content/en/guides/mesheryctl/images/channel set.png b/docs/content/en/guides/mesheryctl/system-commands/images/channel-set.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/channel set.png rename to docs/content/en/guides/mesheryctl/system-commands/images/channel-set.png diff --git a/docs/content/en/guides/mesheryctl/images/channel view.png b/docs/content/en/guides/mesheryctl/system-commands/images/channel-view.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/channel view.png rename to docs/content/en/guides/mesheryctl/system-commands/images/channel-view.png diff --git a/docs/content/en/guides/mesheryctl/images/context create.png b/docs/content/en/guides/mesheryctl/system-commands/images/context-create.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/context create.png rename to docs/content/en/guides/mesheryctl/system-commands/images/context-create.png diff --git a/docs/content/en/guides/mesheryctl/images/context delete.png b/docs/content/en/guides/mesheryctl/system-commands/images/context-delete.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/context delete.png rename to docs/content/en/guides/mesheryctl/system-commands/images/context-delete.png diff --git a/docs/content/en/guides/mesheryctl/images/context flag.png b/docs/content/en/guides/mesheryctl/system-commands/images/context-flag.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/context flag.png rename to docs/content/en/guides/mesheryctl/system-commands/images/context-flag.png diff --git a/docs/content/en/guides/mesheryctl/images/context list.png b/docs/content/en/guides/mesheryctl/system-commands/images/context-list.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/context list.png rename to docs/content/en/guides/mesheryctl/system-commands/images/context-list.png diff --git a/docs/content/en/guides/mesheryctl/images/context view.png b/docs/content/en/guides/mesheryctl/system-commands/images/context-view.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/context view.png rename to docs/content/en/guides/mesheryctl/system-commands/images/context-view.png diff --git a/docs/content/en/guides/mesheryctl/images/dashboard skip.png b/docs/content/en/guides/mesheryctl/system-commands/images/dashboard-skip.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/dashboard skip.png rename to docs/content/en/guides/mesheryctl/system-commands/images/dashboard-skip.png diff --git a/docs/content/en/guides/mesheryctl/images/force stop.png b/docs/content/en/guides/mesheryctl/system-commands/images/force-stop.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/force stop.png rename to docs/content/en/guides/mesheryctl/system-commands/images/force-stop.png diff --git a/docs/content/en/guides/mesheryctl/images/keep namespace.png b/docs/content/en/guides/mesheryctl/system-commands/images/keep-namespace.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/keep namespace.png rename to docs/content/en/guides/mesheryctl/system-commands/images/keep-namespace.png diff --git a/docs/content/en/guides/mesheryctl/images/platform.png b/docs/content/en/guides/mesheryctl/system-commands/images/platform.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/platform.png rename to docs/content/en/guides/mesheryctl/system-commands/images/platform.png diff --git a/docs/content/en/guides/mesheryctl/images/portforward.png b/docs/content/en/guides/mesheryctl/system-commands/images/portforward.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/portforward.png rename to docs/content/en/guides/mesheryctl/system-commands/images/portforward.png diff --git a/docs/content/en/guides/mesheryctl/images/pro list.png b/docs/content/en/guides/mesheryctl/system-commands/images/provider-list.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/pro list.png rename to docs/content/en/guides/mesheryctl/system-commands/images/provider-list.png diff --git a/docs/content/en/guides/mesheryctl/images/pro set.png b/docs/content/en/guides/mesheryctl/system-commands/images/provider-set.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/pro set.png rename to docs/content/en/guides/mesheryctl/system-commands/images/provider-set.png diff --git a/docs/content/en/guides/mesheryctl/images/pro switch.png b/docs/content/en/guides/mesheryctl/system-commands/images/provider-switch.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/pro switch.png rename to docs/content/en/guides/mesheryctl/system-commands/images/provider-switch.png diff --git a/docs/content/en/guides/mesheryctl/images/pro view.png b/docs/content/en/guides/mesheryctl/system-commands/images/provider-view.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/pro view.png rename to docs/content/en/guides/mesheryctl/system-commands/images/provider-view.png diff --git a/docs/content/en/guides/mesheryctl/images/reset.png b/docs/content/en/guides/mesheryctl/system-commands/images/reset.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/reset.png rename to docs/content/en/guides/mesheryctl/system-commands/images/reset.png diff --git a/docs/content/en/guides/mesheryctl/images/restart.png b/docs/content/en/guides/mesheryctl/system-commands/images/restart.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/restart.png rename to docs/content/en/guides/mesheryctl/system-commands/images/restart.png diff --git a/docs/content/en/guides/mesheryctl/images/skipbrowser.png b/docs/content/en/guides/mesheryctl/system-commands/images/skipbrowser.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/skipbrowser.png rename to docs/content/en/guides/mesheryctl/system-commands/images/skipbrowser.png diff --git a/docs/content/en/guides/mesheryctl/images/start.png b/docs/content/en/guides/mesheryctl/system-commands/images/start.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/start.png rename to docs/content/en/guides/mesheryctl/system-commands/images/start.png diff --git a/docs/content/en/guides/mesheryctl/images/stop reset.png b/docs/content/en/guides/mesheryctl/system-commands/images/stop-reset.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/stop reset.png rename to docs/content/en/guides/mesheryctl/system-commands/images/stop-reset.png diff --git a/docs/content/en/guides/mesheryctl/images/stop.png b/docs/content/en/guides/mesheryctl/system-commands/images/stop.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/stop.png rename to docs/content/en/guides/mesheryctl/system-commands/images/stop.png diff --git a/docs/content/en/guides/mesheryctl/images/system check.png b/docs/content/en/guides/mesheryctl/system-commands/images/system-check.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/system check.png rename to docs/content/en/guides/mesheryctl/system-commands/images/system-check.png diff --git a/docs/content/en/guides/mesheryctl/images/system dahboard.png b/docs/content/en/guides/mesheryctl/system-commands/images/system-dashboard.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/system dahboard.png rename to docs/content/en/guides/mesheryctl/system-commands/images/system-dashboard.png diff --git a/docs/content/en/guides/mesheryctl/images/system login.png b/docs/content/en/guides/mesheryctl/system-commands/images/system-login.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/system login.png rename to docs/content/en/guides/mesheryctl/system-commands/images/system-login.png diff --git a/docs/content/en/guides/mesheryctl/images/system status.png b/docs/content/en/guides/mesheryctl/system-commands/images/system-status.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/system status.png rename to docs/content/en/guides/mesheryctl/system-commands/images/system-status.png diff --git a/docs/content/en/guides/mesheryctl/images/system update.png b/docs/content/en/guides/mesheryctl/system-commands/images/system-update.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/system update.png rename to docs/content/en/guides/mesheryctl/system-commands/images/system-update.png diff --git a/docs/content/en/guides/mesheryctl/images/update skip reset.png b/docs/content/en/guides/mesheryctl/system-commands/images/update-skip-reset.png similarity index 100% rename from docs/content/en/guides/mesheryctl/images/update skip reset.png rename to docs/content/en/guides/mesheryctl/system-commands/images/update-skip-reset.png diff --git a/docs/content/en/guides/mesheryctl/system-commands/index.md b/docs/content/en/guides/mesheryctl/system-commands/index.md new file mode 100644 index 0000000000000..5b5728434ab5f --- /dev/null +++ b/docs/content/en/guides/mesheryctl/system-commands/index.md @@ -0,0 +1,180 @@ +--- +title: Mesheryctl system commands +categories: [mesheryctl] +description: Mesheryctl system commands for managing Meshery deployments. +--- + +Let's get familiar with mesheryctl system commands. The syntax of the mesheryctl commands goes as follws : `mesheryctl ` + +## Main_command : system +### start +`mesheryctl system start` : This will initiate Meshery & automatically open it in your default web browser. + +skip-browser + +`mesheryctl system start --skip-browser` : It skips opening Meshery in your browser with the provided URL. + +skip-browser + +`mesheryctl system start --skip-update` : It is used when you want to skip updating Meshery if an update is available. + +skip-browser + +`mesheryctl system start --reset` : It resets your Meshery configuration file to its default configuration. + +`mesheryctl system start --platform string` : It allows you specify a platform for deploying Meshery. + +skip-browser + + +### stop +`mesheryctl system stop` : It stops Meshery resources & delete its associated namespaces. + +skip-browser + +`mesheryctl system stop --reset` : It stops Meshery and resets the Meshery configuration file to its default configuration. + +skip-browser + +`mesheryctl system stop --keep-namespace` : It stops Meshery without deleting the associated namespaces. + +skip-browser + +`mesheryctl system stop --force` : Force stops Meshery instead of gentle way. This is only used in emergency situations when `mesheryctl system stop` can't halt Meshery. + +skip-browser + +### update +`mesheryctl system update` : This updates Meshery itself, not the mesheryctl. Ensure Meshery is running when using this. + +skip-browser + +`mesheryctl system update --skip-reset` : Skips the check for a new manifest file. + +skip-browser + +### reset +`mesheryctl system reset` : Resets Meshery to its default configuration. + +skip-browser + +### restart +`meshryctl system restart` : Stops Meshery and then starts it again. Opens the website in your default browser. + +skip-browser + +### status +`mesheryctl system status` : Displays the status of Meshery components. + +`mesheryctl system status --verbose` : Provides additional data along with Meshery and its component status. + +skip-browser + + +### dashboard +`mesheryctl system dashboard` : Opens the Meshery dashboard in your default browser. + +skip-browser + +`mesheryctl system dashboard --skip-browser` : Provides the link to the dashboard, allowing you to open it in any browser. + +skip-browser + +`mesheryctl system dashboard --port-forward` : If the current port is busy, it opens the dashboard on another port. + +skip-browser + + +### login +`mesheryctl system login` : Authenticates you with your selected provider. + +skip-browser + +### check +`mesheryctl system check` : Performs checks for both pre & post mesh deployment scenarios on Meshery. + +skip-browser + +`mesheryctl system check --preflight` : Runs pre-deployment checks. + +`mesheryctl system check --adapter` : Runs checks for a specific Mesh adapter. + +`mesheryctl system check --adapters` : Runs checks for Meshery adapters + +`mesheryctl system check --components` : Runs checks for Meshery components + +`mesheryctl system check --operator` : Runs checks for Meshery Operator + +## Main_command : system channel +### channel +`mesheryctl system channel set [stable|stable-version|edge|edge-version]` : Used to set the channel. + +`mesheryctl system channel switch [stable|stable-version|edge|edge-version]` : Used to switch between channels. + +skip-browser + +`mesheryctl system channel view --all` : Displays all available channels. + +`mesheryctl system channel view` : Displays the current channel. + +skip-browser + + +## Main_command : system context +### create +`mesheryctl system context create 'context-name'` : Creates a new context with default parameters. + +skip-browser + +`mesheryctl system context create --component stringArray` : Specifies the component to be created in the context. + +`mesheryctl system context create --platform string` : Specifies the platform. + +`mesheryctl system context create --set` : Sets this context as default context. + +`mesheryctl system context create --url string` : Specifies the target URL. + +skip-browser + + +### switch +`mesheryctl system context switch` : Easily switch between different contexts. + +### list +`mesheryctl system context list` : Lists all your available Meshery contexts. + +skip-browser + +### delete +`mesheryctl system context delete` : Delete context. + +skip-browser + + +### view +`mesheryctl system context view` : Display all your contexts with additional information. + +skip-browser + + +## Main_command : system provider +### switch +`mesheryctl system provider switch` : Changes your provider + +skip-browser + +### list +`mesheryctl system provider list` : Lists all available providers + +skip-browser + +### set +`mesheryctl system provider set` : Set your provider + +skip-browser + +### view +`mesheryctl system provider view` : Lists your current context and provider + +skip-browser + diff --git a/docs/content/en/guides/mesheryctl/working-with-mesheryctl.md b/docs/content/en/guides/mesheryctl/working-with-mesheryctl.md index 82f68750f97a2..2c817a4e6df64 100644 --- a/docs/content/en/guides/mesheryctl/working-with-mesheryctl.md +++ b/docs/content/en/guides/mesheryctl/working-with-mesheryctl.md @@ -97,7 +97,7 @@ Endpoints specify the access URL for the Meshery UI, for a deployment. Endpoints #### Question: Can I get an API token using mesheryctl? -Yes, if you need to establish a session with your Meshery Server, you can [authenticate using mesheryctl](/guides/mesheryctl/authenticate-with-meshery-via-cli), using `mesheryctl system login`. +Yes, if you need to establish a session with your Meshery Server, you can [authenticate using mesheryctl]({{< ref "guides/mesheryctl/authenticate-with-meshery-via-cli/index.md" >}}), using `mesheryctl system login`. ## Advanced Installation @@ -121,7 +121,7 @@ services: For an exhaustive list of `mesheryctl` commands and syntax: -- See [`mesheryctl` Command Reference](/reference/mesheryctl). +- See [`mesheryctl` Command Reference]({{< ref "reference/mesheryctl/_index.md" >}}). Guides to using Meshery's various features and components. diff --git a/docs/content/en/guides/performance-management/images/chart.png b/docs/content/en/guides/performance-management/interpreting-performance-test-results/images/chart.png similarity index 100% rename from docs/content/en/guides/performance-management/images/chart.png rename to docs/content/en/guides/performance-management/interpreting-performance-test-results/images/chart.png diff --git a/docs/content/en/guides/performance-management/images/performance-dashboard.png b/docs/content/en/guides/performance-management/interpreting-performance-test-results/images/performance-dashboard.png similarity index 100% rename from docs/content/en/guides/performance-management/images/performance-dashboard.png rename to docs/content/en/guides/performance-management/interpreting-performance-test-results/images/performance-dashboard.png diff --git a/docs/content/en/guides/performance-management/interpreting-performance-test-results.md b/docs/content/en/guides/performance-management/interpreting-performance-test-results/index.md similarity index 87% rename from docs/content/en/guides/performance-management/interpreting-performance-test-results.md rename to docs/content/en/guides/performance-management/interpreting-performance-test-results/index.md index 61b2e7b99559e..629c343f10a1b 100644 --- a/docs/content/en/guides/performance-management/interpreting-performance-test-results.md +++ b/docs/content/en/guides/performance-management/interpreting-performance-test-results/index.md @@ -8,9 +8,9 @@ Once a performance tests and run, it's disco analysis is performed and test resu ## Graphical View - + - + ## Tests diff --git a/docs/content/en/guides/performance-management/images/meshery-and-grafana.png b/docs/content/en/guides/performance-management/managing-performance/images/meshery-and-grafana.png similarity index 100% rename from docs/content/en/guides/performance-management/images/meshery-and-grafana.png rename to docs/content/en/guides/performance-management/managing-performance/images/meshery-and-grafana.png diff --git a/docs/content/en/guides/performance-management/managing-performance.md b/docs/content/en/guides/performance-management/managing-performance/index.md similarity index 95% rename from docs/content/en/guides/performance-management/managing-performance.md rename to docs/content/en/guides/performance-management/managing-performance/index.md index 0944c03713f22..ee99687290da3 100644 --- a/docs/content/en/guides/performance-management/managing-performance.md +++ b/docs/content/en/guides/performance-management/managing-performance/index.md @@ -23,7 +23,7 @@ Performance Profile is a new and improved way to save performance test configura Meshery provides users with a choice about the kind of load generator they prefer to use for a given performance test. Users may set their configure based on their own preference of load generator different from that of the default load generator. -Meshery supports the following load generators and is [extendible](/extensibility) to support others: +Meshery supports the following load generators and is [extendible]({{< ref "reference/extensibility/_index.md" >}}) to support others: - [fortio](#fortio) @@ -62,8 +62,8 @@ Meshery provides performance test results alongside environment metrics, includi Connect Meshery to your existing Grafana instance. Meshery will auto-import the boards of your choosing: - - + + ### Connecting to Grafana diff --git a/docs/content/en/guides/performance-management/images/GrafanaBoards.svg b/docs/content/en/guides/performance-management/meshery-metrics/images/GrafanaBoards.svg similarity index 100% rename from docs/content/en/guides/performance-management/images/GrafanaBoards.svg rename to docs/content/en/guides/performance-management/meshery-metrics/images/GrafanaBoards.svg diff --git a/docs/content/en/guides/performance-management/images/PrometheusCharts.svg b/docs/content/en/guides/performance-management/meshery-metrics/images/PrometheusCharts.svg similarity index 100% rename from docs/content/en/guides/performance-management/images/PrometheusCharts.svg rename to docs/content/en/guides/performance-management/meshery-metrics/images/PrometheusCharts.svg diff --git a/docs/content/en/guides/performance-management/meshery-metrics.md b/docs/content/en/guides/performance-management/meshery-metrics/index.md similarity index 90% rename from docs/content/en/guides/performance-management/meshery-metrics.md rename to docs/content/en/guides/performance-management/meshery-metrics/index.md index d3a2baad8198a..70c97c5226f45 100644 --- a/docs/content/en/guides/performance-management/meshery-metrics.md +++ b/docs/content/en/guides/performance-management/meshery-metrics/index.md @@ -17,14 +17,14 @@ Prometheus Metrics

                      User needs to set the Prometheus URL and API key to create and query boards.

                      -Prometheus Metrics in Meshery +Prometheus Metrics in Meshery Grafana Charts

                      User needs to set the Grafana URL and API key to create and query boards.

                      -Grafana Charts in Meshery +Grafana Charts in Meshery Static Boards diff --git a/docs/content/en/guides/performance-management/images/comparison-table.png b/docs/content/en/guides/performance-management/performance-management/images/comparison-table.png similarity index 100% rename from docs/content/en/guides/performance-management/images/comparison-table.png rename to docs/content/en/guides/performance-management/performance-management/images/comparison-table.png diff --git a/docs/content/en/guides/performance-management/images/comparison.png b/docs/content/en/guides/performance-management/performance-management/images/comparison.png similarity index 100% rename from docs/content/en/guides/performance-management/images/comparison.png rename to docs/content/en/guides/performance-management/performance-management/images/comparison.png diff --git a/docs/content/en/guides/performance-management/images/download-token.png b/docs/content/en/guides/performance-management/performance-management/images/download-token.png similarity index 100% rename from docs/content/en/guides/performance-management/images/download-token.png rename to docs/content/en/guides/performance-management/performance-management/images/download-token.png diff --git a/docs/content/en/guides/performance-management/images/performance-management-dashboard.png b/docs/content/en/guides/performance-management/performance-management/images/performance-management-dashboard.png similarity index 100% rename from docs/content/en/guides/performance-management/images/performance-management-dashboard.png rename to docs/content/en/guides/performance-management/performance-management/images/performance-management-dashboard.png diff --git a/docs/content/en/guides/performance-management/images/performance-profiles.png b/docs/content/en/guides/performance-management/performance-management/images/performance-profiles.png similarity index 100% rename from docs/content/en/guides/performance-management/images/performance-profiles.png rename to docs/content/en/guides/performance-management/performance-management/images/performance-profiles.png diff --git a/docs/content/en/guides/performance-management/images/result-chart.png b/docs/content/en/guides/performance-management/performance-management/images/result-chart.png similarity index 100% rename from docs/content/en/guides/performance-management/images/result-chart.png rename to docs/content/en/guides/performance-management/performance-management/images/result-chart.png diff --git a/docs/content/en/guides/performance-management/images/running-tests-spinner.png b/docs/content/en/guides/performance-management/performance-management/images/running-tests-spinner.png similarity index 100% rename from docs/content/en/guides/performance-management/images/running-tests-spinner.png rename to docs/content/en/guides/performance-management/performance-management/images/running-tests-spinner.png diff --git a/docs/content/en/guides/performance-management/images/running-tests.png b/docs/content/en/guides/performance-management/performance-management/images/running-tests.png similarity index 100% rename from docs/content/en/guides/performance-management/images/running-tests.png rename to docs/content/en/guides/performance-management/performance-management/images/running-tests.png diff --git a/docs/content/en/guides/performance-management/images/smi-dashboard.png b/docs/content/en/guides/performance-management/performance-management/images/smi-dashboard.png similarity index 100% rename from docs/content/en/guides/performance-management/images/smi-dashboard.png rename to docs/content/en/guides/performance-management/performance-management/images/smi-dashboard.png diff --git a/docs/content/en/guides/performance-management/performance-management.md b/docs/content/en/guides/performance-management/performance-management/index.md similarity index 74% rename from docs/content/en/guides/performance-management/performance-management.md rename to docs/content/en/guides/performance-management/performance-management/index.md index 7a91c1e9b102c..6043b91ce7a50 100644 --- a/docs/content/en/guides/performance-management/performance-management.md +++ b/docs/content/en/guides/performance-management/performance-management/index.md @@ -11,15 +11,15 @@ This guide walks through running performance benchmarks using Meshery. Users can ## Installing Meshery -Install and login to Meshery to start running performance benchmarks. See [Installation](/installation) documentation for detailed steps on how to install Meshery. +Install and login to Meshery to start running performance benchmarks. See [Installation]({{< ref "installation/_index.md" >}}) documentation for detailed steps on how to install Meshery. _Meshery dashboard_ -Meshery Dashboard +Meshery Dashboard If you are looking to run performance benchmarks on cloud native infrastructur, you can use Meshery's cloud native infrastructurelifecycle management capabilities to deploy all kinds of cloud native infrastructure on Kubernets. With Meshery's performance benchmarking feature, you can also deploy you application off the mesh and compare the performance and determine the overhead when the app runs on the mesh. -Next, we navigate to the main Performance Testing dashboard. See [Performance Management](/guides/performance-management/managing-performance) to learn more about performance profiles, load generators, Kubernetes cluster, and all kinds of cloud native infrastructure metrics. +Next, we navigate to the main Performance Testing dashboard. See [Performance Management]({{< ref "guides/performance-management/managing-performance/index.md" >}}) to learn more about performance profiles, load generators, Kubernetes cluster, and all kinds of cloud native infrastructure metrics. ## Running Performance Benchmarks Through Meshery UI @@ -29,29 +29,29 @@ On the navigation menu, click on performance. This will open the performance management dashboard as shown below. -Performance Management Dashboard +Performance Management Dashboard _Performance Management Dashboard_ To create a performance profile, click on "Manage Profiles" and then select "+ Add Performance Profile". -Performance Profiles +Performance Profiles _Performance Profiles_ This will open up a popup window where you can fill out the test configuration for running your benchmarks. -Performance Test Configuration +Performance Test Configuration _Configuring a Performance Test_ You can now save the profile and run the test. The test will continue to run in the background even if you close the popup. -Running a performance test +Running a performance test Once the test is done, you would be able to see the results of the test below. -Running a performance test +Running a performance test _Performance Test Results_ @@ -59,11 +59,11 @@ You can then go back to your performance profile and get these results anytime. You can also compare different test results in Meshery and draw insights. For example, you can run this test with your application running on different cloud native infrastructure and check which performs better. -Comparing Test Results +Comparing Test Results _Selecting multiple test results_ -Comparing Test Results +Comparing Test Results _Comparing multiple test results_ @@ -127,7 +127,7 @@ Download the token from the Meshery Dashboard by clicking on the profile icon on _Downloading the token_ -SMI Conformance Test Results +SMI Conformance Test Results You can use this token to authenticate the instance of Meshery running in your CI/CD workflow. diff --git a/docs/content/en/guides/troubleshooting/_index.md b/docs/content/en/guides/troubleshooting/_index.md index e850b7f8395ca..af04de1a02e28 100644 --- a/docs/content/en/guides/troubleshooting/_index.md +++ b/docs/content/en/guides/troubleshooting/_index.md @@ -7,6 +7,6 @@ Troubleshooting guides to using Meshery's various features and components. #### See Also -- [Meshery Error Code Reference](/reference/error-codes) +- [Meshery Error Code Reference]({{< ref "reference/error-codes.md" >}}) {{< discuss >}} diff --git a/docs/content/en/guides/troubleshooting/enabling-extensions-locally.md b/docs/content/en/guides/troubleshooting/enabling-extensions-locally.md index c1b8a467e039a..e560aa56d4270 100644 --- a/docs/content/en/guides/troubleshooting/enabling-extensions-locally.md +++ b/docs/content/en/guides/troubleshooting/enabling-extensions-locally.md @@ -21,7 +21,7 @@ If you cannot find the repository or it is private, the issue is likely related ### Loosely-Coupled Extensions These extensions communicate with Meshery Server through standard APIs. Issues are typically easier to diagnose. -- Example: [Meshery Adapters](/concepts/architecture/adapters) like the [meshery-istio](https://github.com/meshery-extensions/meshery-istio) adapter. +- Example: [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}}) like the [meshery-istio](https://github.com/meshery-extensions/meshery-istio) adapter. - Common Issues: Networking problems, port conflicts, or component-specific errors. - Debugging Steps: Use standard tools like `docker ps` to check if the container is running and `docker logs ` to inspect its logs for errors. @@ -56,5 +56,5 @@ Given that you cannot build the extension from source, a solution typically requ While you can attempt to experiment by manually testing different versions of packages from the [meshery-extensions-packages](https://github.com/meshery-extensions/meshery-extensions-packages) repository, this trial-and-error method is not guaranteed to work. The most reliable path forward is to: -- **Seek assistance:** Ask for guidance in the [Meshery community](/project/community). +- **Seek assistance:** Ask for guidance in the [Meshery community]({{< ref "project/community.md" >}}). - **Check for requirements:** To check access requirements or find maintainers, consult the [community handbook](https://meshery.io/community). \ No newline at end of file diff --git a/docs/content/en/guides/troubleshooting/images/provider_screenshot.png b/docs/content/en/guides/troubleshooting/installation/images/provider_screenshot.png similarity index 100% rename from docs/content/en/guides/troubleshooting/images/provider_screenshot.png rename to docs/content/en/guides/troubleshooting/installation/images/provider_screenshot.png diff --git a/docs/content/en/guides/troubleshooting/installation.md b/docs/content/en/guides/troubleshooting/installation/index.md similarity index 95% rename from docs/content/en/guides/troubleshooting/installation.md rename to docs/content/en/guides/troubleshooting/installation/index.md index 2e1e171463644..ac78838284d01 100644 --- a/docs/content/en/guides/troubleshooting/installation.md +++ b/docs/content/en/guides/troubleshooting/installation/index.md @@ -83,7 +83,7 @@ docker-desktop
        Once Meshery is installed, the remote provider "Meshery" can be chosen from UI or by using the command `mesheryctl system login`: -![Providers](/guides/troubleshooting/images/provider_screenshot.png) +![Providers](images/provider_screenshot.png) ```bash ➜ ~ mesheryctl system login @@ -101,9 +101,9 @@ time="2021-11-10T11:05:30Z" level=error msg="[Initialize Provider]: Failed to ge For more details about Meshery Providers: -- [Extensibility: Providers](/extensibility/providers) +- [Extensibility: Providers]({{< ref "reference/extensibility/providers/index.md" >}}) ## See Also -- [Meshery Error Code Reference](/reference/error-codes) +- [Meshery Error Code Reference]({{< ref "reference/error-codes.md" >}}) diff --git a/docs/content/en/guides/troubleshooting/meshery-operator-meshsync.md b/docs/content/en/guides/troubleshooting/meshery-operator-meshsync.md index 9c321c29d9c33..b88458254652a 100644 --- a/docs/content/en/guides/troubleshooting/meshery-operator-meshsync.md +++ b/docs/content/en/guides/troubleshooting/meshery-operator-meshsync.md @@ -5,15 +5,15 @@ categories: [troubleshooting] --- {{% alert color="info" title="What is Meshery Operator?" %}} -Meshery Operator controls and monitors the lifecycle of components deployed inside Meshery-managed Kubernetes clusters. Learn more about Meshery's architecture. +Meshery Operator controls and monitors the lifecycle of components deployed inside Meshery-managed Kubernetes clusters. Learn more about Meshery's architecture. {{% /alert %}} -This guide offers comprehensive for troubleshooting instructions for [Meshery Operator](/concepts/architecture/operator) and its custom controllers, [MeshSync](/concepts/architecture/meshsync) and [Broker](/concepts/architecture/broker). Follow the steps outlined in this document to ensure a smooth Meshery deployment. +This guide offers comprehensive for troubleshooting instructions for [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) and its custom controllers, [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) and [Broker]({{< ref "concepts/architecture/broker/index.md" >}}). Follow the steps outlined in this document to ensure a smooth Meshery deployment. First, understand the [Meshery Operator Deployment Scenarios](#meshery-operator-deployment-scenarios) and the [Status of Meshery Operator, MeshSync, and Meshery Broker](#understanding-the-status-of-meshery-operator-meshsync-and-meshery-broker) to identify the deployment model fitting of your environment. Then, follow the guidance under the respective scenario to troubleshoot accordingly. {{% alert color="dark" title="Meshery Error Code Reference" %}} -Have specific error with an error code? See the Meshery Error Code Reference for probable cause and suggested remediations. +Have specific error with an error code? See the Meshery Error Code Reference for probable cause and suggested remediations. {{% /alert %}} ## Understanding the Status of Meshery Operator, MeshSync, and Meshery Broker @@ -48,7 +48,7 @@ Because Meshery is versatile in its deployment models, there are different of sc -Whether using [`mesheryctl system start`](/installation), [`helm install`](/installation/kubernetes/helm) or `make run-local`, Meshery Server will automatically connect to any available Kubernetes clusters found in your kubeconfig (under `$HOME/.kube/config`). Once connected, operator, broker(NATS) and meshsync will automatically get deployed in the same clusters. +Whether using [`mesheryctl system start`]({{< ref "installation/_index.md" >}}), [`helm install`]({{< ref "installation/kubernetes/helm.md" >}}) or `make run-local`, Meshery Server will automatically connect to any available Kubernetes clusters found in your kubeconfig (under `$HOME/.kube/config`). Once connected, operator, broker(NATS) and meshsync will automatically get deployed in the same clusters. If everything is fine, by viewing the connection in Meshery UI, MeshSync should be in **CONNECTED:** state. Otherwise, check the Operator's pod logs: @@ -66,7 +66,7 @@ Some common failure situations that Meshery users might face are described below 1. **Situation:** No deployment of Meshery Operator, MeshSync, and Broker. 1. **Probable cause:** Meshery Server cannot connect to Kubernetes cluster; cluster unreachable or kubeconfig without proper permissions needed to deploy Meshery Operator; Kubernetes config initialization issues. -1. **Situation:** Meshery Operator with MeshSync and Broker deployed, but Meshery Server is not receiving data from MeshSync or data the [Meshery Database](/concepts/architecture/database) is stale. +1. **Situation:** Meshery Operator with MeshSync and Broker deployed, but Meshery Server is not receiving data from MeshSync or data the [Meshery Database]({{< ref "concepts/architecture/database/index.md" >}}) is stale. 1. **Probable cause:** 2. Meshery Server lost subscription to Meshery Broker; Broker server not exposed to external IP; MeshSync not connected to Broker; MeshSync not running; Meshery Database is stale. 3. The SQL database in Meshery serves as a cache for cluster state. A single button allows users to dump/reset the Meshery Database. @@ -119,8 +119,8 @@ Future Enhancements for Troubleshooting: ## See Also -- [Troubleshooting Meshery Installations](/guides/troubleshooting/installation) -- [Troubleshooting Errors while running Meshery](/guides/troubleshooting/meshery-server) +- [Troubleshooting Meshery Installations]({{< ref "guides/troubleshooting/installation/index.md" >}}) +- [Troubleshooting Errors while running Meshery]({{< ref "guides/troubleshooting/meshery-server.md" >}}) {{< related-discussions tag="meshery" >}} diff --git a/docs/content/en/guides/troubleshooting/meshery-server.md b/docs/content/en/guides/troubleshooting/meshery-server.md index 82dd934e98f12..553840e5753d3 100644 --- a/docs/content/en/guides/troubleshooting/meshery-server.md +++ b/docs/content/en/guides/troubleshooting/meshery-server.md @@ -48,4 +48,4 @@ make: *** [Makefile:76: server] Error 1 #### See Also -- [Error Code Reference](/reference/error-codes) +- [Error Code Reference]({{< ref "reference/error-codes.md" >}}) diff --git a/docs/content/en/guides/tutorials/_index.md b/docs/content/en/guides/tutorials/_index.md index e03acef6799b1..6d69da3698c7d 100644 --- a/docs/content/en/guides/tutorials/_index.md +++ b/docs/content/en/guides/tutorials/_index.md @@ -3,4 +3,4 @@ title: Tutorials categories: [tutorials] description: Explore the tutorials to learn how to use Meshery for collaboratively managing infrastructure. --- -πŸ§‘β€πŸ”¬ Explore these tutorials to learn how to use Meshery for collaboratively managing infrastructure. Access the [Meshery Playground](/installation/playground) as a convenient resource for the labs in these tutorials. +πŸ§‘β€πŸ”¬ Explore these tutorials to learn how to use Meshery for collaboratively managing infrastructure. Access the [Meshery Playground]({{< ref "installation/playground.md" >}}) as a convenient resource for the labs in these tutorials. diff --git a/docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/add_repo.png b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/add_repo.png similarity index 100% rename from docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/add_repo.png rename to docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/add_repo.png diff --git a/docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/artifacthub_control_panel.png b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/artifacthub_control_panel.png similarity index 100% rename from docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/artifacthub_control_panel.png rename to docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/artifacthub_control_panel.png diff --git a/docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/design-download.png b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/design-download.png similarity index 100% rename from docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/design-download.png rename to docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/design-download.png diff --git a/docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/designs.png b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/designs.png similarity index 100% rename from docs/content/en/guides/tutorials/artifacthub/images/publish-to-artifacthub/designs.png rename to docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/images/designs.png diff --git a/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub.md b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/index.md similarity index 83% rename from docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub.md rename to docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/index.md index 4709a96759bab..77a741c0c24c7 100644 --- a/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub.md +++ b/docs/content/en/guides/tutorials/artifacthub/publish-to-artifacthub/index.md @@ -13,7 +13,7 @@ In this tutorial, we'll see how to export a design from Meshery, which we will u ## Prerequisites -1. Access to Meshery. [Install Meshery](/installation) or access the [Meshery Playground](https://play.meshery.io). +1. Access to Meshery. [Install Meshery]({{< ref "installation/_index.md" >}}) or access the [Meshery Playground](https://play.meshery.io). 2. An Artifact Hub repository. ## Steps @@ -23,23 +23,23 @@ You can access it from the left-hand menu in Meshery. The URL will be: - Locally: [http://localhost:9081/configuration/designs?view=grid](http://localhost:9081/configuration/designs?view=grid) - Playground: [https://playground.meshery.io/configuration/designs?view=grid](https://playground.meshery.io/configuration/designs?view=grid) -![](/guides/tutorials/artifacthub/images/publish-to-artifacthub/designs.png) +![](images/designs.png) {{% alert color="info" title="Can't find your design?" %}} If you don't see your design, check your Organization and Workspace selections. Designs are scoped to a Workspace, so make sure you have the correct Workspace selected in the dropdown at the top of the page. If you don't have any designs in that Workspace, you can switch to another Workspace or create a new design in the current one. -If you don't have any designs, you can create one by following the [Create a Design tutorial](/guides/tutorials/create-design). +If you don't have any designs, you can create one by following the [Create a Design tutorial]({{< ref "guides/configuration-management/creating-a-meshery-design.md" >}}). {{% /alert %}} ### 2. Click to download your design You can find the download button in the design's card in the grid view, or in the design's details page. This will download a `tar` archive containing your design and the metadata files to publish it to Artifact Hub. -![](/guides/tutorials/artifacthub/images/publish-to-artifacthub/design-download.png) +![](images/design-download.png) ### 3. Prepare your Artifact Hub repository You will need to have an Artifact Hub repository already created with Kind as Meshery Designs. See [Artifact Hub documentation](https://artifacthub.io/docs/topics/repositories/meshery-designs/) for more information on managing repositories. -![](/guides/tutorials/artifacthub/images/publish-to-artifacthub/add_repo.png) +![](images/add_repo.png) ### 4. Push Design to Artifact Hub repository @@ -50,9 +50,9 @@ After exporting your design as a Meshery Design (OCI image) from Kanvas, a `.tar 4. Move these files into your prepared Artifact Hub repository. 5. Commit and push the changes to your repository. -![](/guides/tutorials/artifacthub/images/publish-to-artifacthub/artifacthub_control_panel.png) +![](images/artifacthub_control_panel.png) ### 5. Verify repository in Artifact Hub Once the files are pushed to the Artifact Hub repo you will need to wait until Artifact Hub indexes it. You can verify the status of the repository in the Artifact Hub control panel. - \ No newline at end of file + diff --git a/docs/content/en/guides/tutorials/aws/images/aws-controllers/aws-connection.png b/docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery/images/aws-connection.png similarity index 100% rename from docs/content/en/guides/tutorials/aws/images/aws-controllers/aws-connection.png rename to docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery/images/aws-connection.png diff --git a/docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery.md b/docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery/index.md similarity index 95% rename from docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery.md rename to docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery/index.md index f5604b10736ec..0f52f7b37cb05 100644 --- a/docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery.md +++ b/docs/content/en/guides/tutorials/aws/deploy-aws-ec2-instances-with-meshery/index.md @@ -19,7 +19,7 @@ In this guide, you'll explore how to deploy AWS resources, including setup and a ### Prerequisites -1. [Self Hosted Meshery Installation](/installation). +1. [Self Hosted Meshery Installation]({{< ref "installation/_index.md" >}}). 1. **AWS Account**: An active AWS account is required for accessing AWS resources. 1. **Kubernetes Cluster**: A running Kubernetes cluster, such as Minikube or EKS. @@ -59,9 +59,9 @@ To begin, connect your Kubernetes cluster to Meshery. This guide uses `minikube` - **In-Cluster Deployment**: Deploys Meshery within the Kubernetes cluster using Helm inside the meshery namespace. - **Out-of-Cluster Deployment**: Runs Meshery in Docker containers, allowing external connectivity to the Minikube cluster. -For this guide, the `in-cluster deployment` method is used. Follow this [setup guide for Meshery on Minikube](/installation/kubernetes/minikube) to deploy Meshery in-cluster. After the deployment, open the Meshery UI at `localhost:9081` to verify that the cluster is listed. Click on the cluster name to ping and confirm connectivity. +For this guide, the `in-cluster deployment` method is used. Follow this [setup guide for Meshery on Minikube]({{< ref "installation/kubernetes/minikube/index.md" >}}) to deploy Meshery in-cluster. After the deployment, open the Meshery UI at `localhost:9081` to verify that the cluster is listed. Click on the cluster name to ping and confirm connectivity. -![Connect Minikube Cluster](/guides/tutorials/aws/images/aws-controllers/aws-connection.png) +![Connect Minikube Cluster](images/aws-connection.png) ### 2. Configure and Deploy the EC2 Controller diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/add-custom-html.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/add-custom-html.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/add-custom-html.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/add-custom-html.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/copy-url.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/copy-url.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/copy-url.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/copy-url.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embedded-design-preview.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embedded-design-preview.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embedded-design-preview.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embedded-design-preview.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embeddesign-HTML.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embeddesign-HTML.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embeddesign-HTML.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embeddesign-HTML.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embeddesign.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embeddesign.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/embeddesign.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/embeddesign.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/meshery-design-custom-html.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/meshery-design-custom-html.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/meshery-design-custom-html.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/meshery-design-custom-html.png diff --git a/docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/upload-js-wordpress.png b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/upload-js-wordpress.png similarity index 100% rename from docs/content/en/guides/tutorials/images/embedding-design-in-wordpress/upload-js-wordpress.png rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/images/upload-js-wordpress.png diff --git a/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress.md b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/index.md similarity index 79% rename from docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress.md rename to docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/index.md index 7335a6954efb0..7f574be650669 100644 --- a/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress.md +++ b/docs/content/en/guides/tutorials/wordpress/embedding-meshery-design-in-wordpress/index.md @@ -21,23 +21,23 @@ This tutorial assumes that you have created a design or have an existing one. If 3. Click the download icon next to **Embed Design** from the list. - ![Embed Design](/guides/tutorials/images/embedding-design-in-wordpress/embeddesign.png) + ![Embed Design](images/embeddesign.png) 4. This will show the `js` file to download and the HTML code snipped to copy. - ![Embed Design](/guides/tutorials/images/embedding-design-in-wordpress/embeddesign-HTML.png) + ![Embed Design](images/embeddesign-HTML.png) 5. Now, head over to WordPress and begin by uploading the `js` file to it. Ideally you will upload it to Media. - ![Upload to WordPress](/guides/tutorials/images/embedding-design-in-wordpress/upload-js-wordpress.png) + ![Upload to WordPress](images/upload-js-wordpress.png) 6. Next, click on the uploaded file in WordPress and copy the File URL. You will need this later. - ![Copy URL](/guides/tutorials/images/embedding-design-in-wordpress/copy-url.png) + ![Copy URL](images/copy-url.png) 7. Open the WordPress post where you want to embed the design in edit mode and add a _Custom HTML_ block. - ![Copy URL](/guides/tutorials/images/embedding-design-in-wordpress/add-custom-html.png) + ![Copy URL](images/add-custom-html.png) 8. Paste the following CSS code as it is, followed by the **Embed Code** copied from **Meshery Design Configurator**. Update the script source value to the URL copied from WordPress. ``` @@ -74,11 +74,11 @@ This tutorial assumes that you have created a design or have an existing one. If
        ``` - ![Copy URL](/guides/tutorials/images/embedding-design-in-wordpress/meshery-design-custom-html.png) + ![Copy URL](images/meshery-design-custom-html.png) 9. Click **Preview** to validate that the design is rendered. - ![Copy URL](/guides/tutorials/images/embedding-design-in-wordpress/embedded-design-preview.png) + ![Copy URL](images/embedded-design-preview.png) 10. Publish the WordPress post and share. diff --git a/docs/content/en/installation/_index.md b/docs/content/en/installation/_index.md index 6ec60c69d1dd7..78e8879d3a9bc 100644 --- a/docs/content/en/installation/_index.md +++ b/docs/content/en/installation/_index.md @@ -15,4 +15,4 @@ weight: 5 Meshery deploys as a set of Docker containers to either a Docker host or a Kubernetes cluster. A given deployment of Meshery can be described as either an _in-cluster_ or an _out-of-cluster_ deployment. Meshery runs as a standalone management plane on a Docker host (_out-of-cluster_) or within a Kubernetes cluster (_in-cluster_). See the complete list of supported platforms below. -If you are deciding which installation path fits your environment, start with the [Compatibility Matrix](/installation/compatibility-matrix). +If you are deciding which installation path fits your environment, start with the [Compatibility Matrix]({{< ref "installation/compatibility-matrix/_index.md" >}}). diff --git a/docs/content/en/installation/codespaces/index.md b/docs/content/en/installation/codespaces/index.md index 33a3f949dde3a..cf7ec4f4ca38b 100644 --- a/docs/content/en/installation/codespaces/index.md +++ b/docs/content/en/installation/codespaces/index.md @@ -12,7 +12,7 @@ Use Minikube in GitHub Codespaces to setup your development environment for Mesh

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        @@ -68,11 +68,11 @@ Once configured, execute the following command to start Meshery. {{< code code="mesheryctl system start" >}} -If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here](/guides/mesheryctl/authenticate-with-meshery-via-cli) to learn more. +If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here]({{< ref "guides/mesheryctl/authenticate-with-meshery-via-cli/index.md" >}}) to learn more. ## Installation: Using Helm -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ## Installation: Manual Steps @@ -109,11 +109,11 @@ _Note_: Make sure _current-context_ is set to _minikube_. {{< code code="kubectl config view --minify --flatten > config_minikube.yaml" >}}
        -Meshery should now be connected with your managed Kubernetes instance. Take a look at the [Meshery guides](/guides) for advanced usage tips. +Meshery should now be connected with your managed Kubernetes instance. Take a look at the [Meshery guides]({{< ref "guides/_index.md" >}}) for advanced usage tips. # Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/compatibility-matrix/_index.md b/docs/content/en/installation/compatibility-matrix/_index.md index 1fada9375ea43..88dbef0e00935 100644 --- a/docs/content/en/installation/compatibility-matrix/_index.md +++ b/docs/content/en/installation/compatibility-matrix/_index.md @@ -10,7 +10,7 @@ cascade: ## Dependency and Platform Compatibility for Installation -Use this page to choose the Meshery installation path that matches your environment. Meshery itself runs on [Docker](/installation/docker) or [Kubernetes](/installation/kubernetes). [mesheryctl](/installation/mesheryctl) is the common control point for installing, configuring, and operating Meshery across those targets. +Use this page to choose the Meshery installation path that matches your environment. Meshery itself runs on [Docker]({{< ref "installation/docker/_index.md" >}}) or [Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}). [mesheryctl]({{< ref "installation/mesheryctl.md" >}}) is the common control point for installing, configuring, and operating Meshery across those targets. {{% alert color="info" title="What is actually required?" %}} Docker is enough to run Meshery locally and use many of its features. A Kubernetes cluster is required for most infrastructure lifecycle management features, including deploying and operating Cloud-based resources through Meshery. See the [Feature dependency matrix](#feature-dependency-matrix) below for specifics. @@ -20,54 +20,54 @@ Docker is enough to run Meshery locally and use many of its features. A Kubernet | Installation path | Runs on | Required dependencies | Kubernetes required | Best for | | --- | --- | --- | --- | --- | -| [`mesheryctl`](/installation/mesheryctl) only | macOS, Linux, Windows | `mesheryctl` installed via Bash, Homebrew, Scoop, or direct download | No | Installing, upgrading, and managing Meshery deployments | -| [Docker deployment](/installation/docker) (`mesheryctl system start -p docker`) | macOS, Linux, Windows | `mesheryctl`, Docker Engine or Docker Desktop, Docker Compose | No, to start Meshery. Yes, to manage Kubernetes infrastructure through Meshery. | Local evaluation and single-host deployments | -| [Kubernetes deployment](/installation/kubernetes) (`mesheryctl system start`) | Any environment that can reach a cluster | `mesheryctl`, `kubectl`, access to an active Kubernetes cluster | Yes | Full Meshery management workflows on Kubernetes | -| [Helm deployment](/installation/kubernetes/helm) | Any environment that can reach a cluster | Helm v3, `kubectl`, access to an active Kubernetes cluster | Yes | Teams standardizing on Helm-based installation | -| [Docker Extension](/installation/docker/docker-extension) | Docker Desktop | Docker Desktop, Kubernetes enabled in Docker Desktop, Docker Extension support | Yes | Docker Desktop users who want the shortest local setup | -| [GitHub Codespaces](/installation/codespaces) | GitHub Codespaces | `mesheryctl`, Minikube, `kubectl`, enough Codespaces CPU and memory to run Minikube | Yes | Browser-based evaluation and contributor environments | +| [`mesheryctl`]({{< ref "installation/mesheryctl.md" >}}) only | macOS, Linux, Windows | `mesheryctl` installed via Bash, Homebrew, Scoop, or direct download | No | Installing, upgrading, and managing Meshery deployments | +| [Docker deployment]({{< ref "installation/docker/_index.md" >}}) (`mesheryctl system start -p docker`) | macOS, Linux, Windows | `mesheryctl`, Docker Engine or Docker Desktop, Docker Compose | No, to start Meshery. Yes, to manage Kubernetes infrastructure through Meshery. | Local evaluation and single-host deployments | +| [Kubernetes deployment]({{< ref "installation/kubernetes/_index.md" >}}) (`mesheryctl system start`) | Any environment that can reach a cluster | `mesheryctl`, `kubectl`, access to an active Kubernetes cluster | Yes | Full Meshery management workflows on Kubernetes | +| [Helm deployment]({{< ref "installation/kubernetes/helm.md" >}}) | Any environment that can reach a cluster | Helm v3, `kubectl`, access to an active Kubernetes cluster | Yes | Teams standardizing on Helm-based installation | +| [Docker Extension]({{< ref "installation/docker/docker-extension/index.md" >}}) | Docker Desktop | Docker Desktop, Kubernetes enabled in Docker Desktop, Docker Extension support | Yes | Docker Desktop users who want the shortest local setup | +| [GitHub Codespaces]({{< ref "installation/codespaces/index.md" >}}) | GitHub Codespaces | `mesheryctl`, Minikube, `kubectl`, enough Codespaces CPU and memory to run Minikube | Yes | Browser-based evaluation and contributor environments | ## Environment Matrix | Environment | Supported installation paths | Hard dependencies | Recommended additions | Notes | | --- | --- | --- | --- | --- | -| [Linux or macOS](/installation/linux-mac) | `mesheryctl`, Docker, Kubernetes, Helm | `mesheryctl` for standard installs | Docker Desktop or Docker Engine, `kubectl`, Helm | This is the most direct path for local Docker and Kubernetes workflows. | -| [Windows](/installation/windows) | `mesheryctl`, Docker, Docker Extension, Kubernetes | `mesheryctl`; Docker Desktop for container-based installs | WSL2, Kubernetes enabled in Docker Desktop, `kubectl` | Meshery supports Windows workflows, but Docker-backed paths are generally the smoothest option. | -| [Docker Desktop](/installation/docker/docker-extension) | Docker deployment, Docker Extension | Docker Desktop with Compose support | Kubernetes enabled when you want cluster-backed features | Best fit for local development and evaluation on laptops. | -| Remote or managed Kubernetes cluster | Kubernetes deployment, Helm | Reachable cluster, valid kubeconfig, `kubectl` | LoadBalancer, Ingress, or port-forward access to Meshery | Good fit for shared team environments and production-style installs. See also [Upgrading Meshery](/installation/upgrades). | -| [GitHub Codespaces](/installation/codespaces) | Kubernetes deployment in Minikube | Codespace with enough resources, Minikube, `kubectl`, `mesheryctl` | VS Code desktop or browser-based Codespaces access | Useful when you do not want to manage a local cluster. | +| [Linux or macOS]({{< ref "installation/linux-mac/_index.md" >}}) | `mesheryctl`, Docker, Kubernetes, Helm | `mesheryctl` for standard installs | Docker Desktop or Docker Engine, `kubectl`, Helm | This is the most direct path for local Docker and Kubernetes workflows. | +| [Windows]({{< ref "installation/windows/_index.md" >}}) | `mesheryctl`, Docker, Docker Extension, Kubernetes | `mesheryctl`; Docker Desktop for container-based installs | WSL2, Kubernetes enabled in Docker Desktop, `kubectl` | Meshery supports Windows workflows, but Docker-backed paths are generally the smoothest option. | +| [Docker Desktop]({{< ref "installation/docker/docker-extension/index.md" >}}) | Docker deployment, Docker Extension | Docker Desktop with Compose support | Kubernetes enabled when you want cluster-backed features | Best fit for local development and evaluation on laptops. | +| Remote or managed Kubernetes cluster | Kubernetes deployment, Helm | Reachable cluster, valid kubeconfig, `kubectl` | LoadBalancer, Ingress, or port-forward access to Meshery | Good fit for shared team environments and production-style installs. See also [Upgrading Meshery]({{< ref "installation/upgrades/index.md" >}}). | +| [GitHub Codespaces]({{< ref "installation/codespaces/index.md" >}}) | Kubernetes deployment in Minikube | Codespace with enough resources, Minikube, `kubectl`, `mesheryctl` | VS Code desktop or browser-based Codespaces access | Useful when you do not want to manage a local cluster. | ## Feature Dependency Matrix | Capability | Docker host only | Reachable Kubernetes cluster | | --- | --- | --- | | Start Meshery locally and open the UI | Yes | Optional | -| Run [`mesheryctl system check --preflight`](/guides/mesheryctl/running-system-checks-using-mesheryctl) | Yes | Optional | +| Run [`mesheryctl system check --preflight`]({{< ref "guides/mesheryctl/running-system-checks-using-mesheryctl.md" >}}) | Yes | Optional | | Use performance management features | Yes | Yes | | Deploy and manage Kubernetes infrastructure | No | Yes | -| Use [Meshery Operator and MeshSync](/guides/troubleshooting/meshery-operator-meshsync) and cluster-backed adapters | No | Yes | +| Use [Meshery Operator and MeshSync]({{< ref "guides/troubleshooting/meshery-operator-meshsync.md" >}}) and cluster-backed adapters | No | Yes | | Use the Docker Extension workflow | No | Yes, through Docker Desktop Kubernetes | ## Compatibility Stipulations - Meshery should be installed onto platform versions that are still maintained by their upstream project or vendor. -- For Kubernetes-based installs, use a Kubernetes release that is still within the Kubernetes project's supported maintenance window and follow the operational guidance in [Install Meshery on Kubernetes](/installation/kubernetes). +- For Kubernetes-based installs, use a Kubernetes release that is still within the Kubernetes project's supported maintenance window and follow the operational guidance in [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}). - Match `kubectl` to the lifecycle of the cluster you target and keep it within the Kubernetes version skew policy. -- For Docker-based installs, use a current Docker Engine or Docker Desktop release that includes Compose support and can run the Meshery container set reliably. See [Install Meshery on Docker](/installation/docker). -- The Docker Extension path applies when Docker Desktop supports extensions and Kubernetes is enabled in Docker Desktop. See [Install Docker Extension for Meshery](/installation/docker/docker-extension). -- Standard Meshery installation does not require local Go or Node.js runtimes. Those are contributor dependencies for [building Meshery from source](/project/contributing). -- If you plan to run Meshery out-of-cluster against Kubernetes, ensure the host running Meshery can reach the Kubernetes API and any broker endpoints exposed by your cluster. If connectivity fails, start with [Troubleshooting Meshery Installations](/guides/troubleshooting/installation). +- For Docker-based installs, use a current Docker Engine or Docker Desktop release that includes Compose support and can run the Meshery container set reliably. See [Install Meshery on Docker]({{< ref "installation/docker/_index.md" >}}). +- The Docker Extension path applies when Docker Desktop supports extensions and Kubernetes is enabled in Docker Desktop. See [Install Docker Extension for Meshery]({{< ref "installation/docker/docker-extension/index.md" >}}). +- Standard Meshery installation does not require local Go or Node.js runtimes. Those are contributor dependencies for [building Meshery from source]({{< ref "project/contributing/_index.md" >}}). +- If you plan to run Meshery out-of-cluster against Kubernetes, ensure the host running Meshery can reach the Kubernetes API and any broker endpoints exposed by your cluster. If connectivity fails, start with [Troubleshooting Meshery Installations]({{< ref "guides/troubleshooting/installation/index.md" >}}). ## Release Channel Guidance -Meshery publishes `stable` and `edge` release channels. Use the release channel that matches how quickly your environment adopts new Kubernetes minors. See [Build & Release (CI)](/project/contributing/build-and-release) for how these channels are produced and [Upgrading Meshery](/installation/upgrades) for changing deployed components over time. +Meshery publishes `stable` and `edge` release channels. Use the release channel that matches how quickly your environment adopts new Kubernetes minors. See [Build & Release (CI)]({{< ref "project/contributing/build-and-release.md" >}}) for how these channels are produced and [Upgrading Meshery]({{< ref "installation/upgrades/index.md" >}}) for changing deployed components over time. | Release channel | Intended use | Kubernetes guidance | | --- | --- | --- | -| [`stable`](/project/contributing/build-and-release/#stable-channel) | Production environments and conservative upgrades | Use for environments that stay on maintained platform releases and adopt Kubernetes upgrades through planned release management. | -| [`edge`](/project/contributing/build-and-release/#edge-channel) | Early validation, development, and upcoming-platform testing | Use when validating Meshery against newly introduced platform releases before they become part of your normal stable rollout. | +| [`stable`]({{< ref "project/contributing/build-and-release.md#stable-channel" >}}) | Production environments and conservative upgrades | Use for environments that stay on maintained platform releases and adopt Kubernetes upgrades through planned release management. | +| [`edge`]({{< ref "project/contributing/build-and-release.md#edge-channel" >}}) | Early validation, development, and upcoming-platform testing | Use when validating Meshery against newly introduced platform releases before they become part of your normal stable rollout. | -Stable and edge artifacts are published separately in Meshery's build and release process, so cluster compatibility validation should be considered together with your selected release channel and your [upgrade path](/installation/upgrades). +Stable and edge artifacts are published separately in Meshery's build and release process, so cluster compatibility validation should be considered together with your selected release channel and your [upgrade path]({{< ref "installation/upgrades/index.md" >}}). ## Validation Checks @@ -75,7 +75,7 @@ Validate your environment before installing Meshery: {{< code code="mesheryctl system check --preflight" >}} -For a deeper walkthrough of what these checks validate, see [Running system checks using Meshery CLI](/guides/mesheryctl/running-system-checks-using-mesheryctl) and the [`mesheryctl system check` reference](/reference/mesheryctl/system/check). +For a deeper walkthrough of what these checks validate, see [Running system checks using Meshery CLI]({{< ref "guides/mesheryctl/running-system-checks-using-mesheryctl.md" >}}) and the [`mesheryctl system check` reference]({{< ref "reference/mesheryctl/system/check.md" >}}). If you plan to use Docker, verify that the Docker Engine and Compose plugin are available: @@ -90,17 +90,17 @@ If you plan to use Kubernetes, verify that your current context points to the ta - Choose the Docker Extension when you already standardize on Docker Desktop and want a guided local workflow. - Choose Docker when you want to get Meshery running quickly on a single machine. - Choose Kubernetes or Helm when Meshery needs to manage Kubernetes-backed infrastructure and team environments. -- Choose the Meshery Playground when you want to try Meshery without installing anything locally. See [Try Meshery Playground](/playground). +- Choose the Meshery Playground when you want to try Meshery without installing anything locally. See [Try Meshery Playground]({{< ref "installation/playground.md" >}}). -For rollout planning after initial installation, continue with [Upgrading Meshery](/installation/upgrades). +For rollout planning after initial installation, continue with [Upgrading Meshery]({{< ref "installation/upgrades/index.md" >}}). ## Related Reading -- [Install mesheryctl](/installation/mesheryctl) -- [Install Meshery on Docker](/installation/docker) -- [Install Meshery on Kubernetes](/installation/kubernetes) -- [Install Docker Extension for Meshery](/installation/docker/docker-extension) -- [Build & Release (CI)](/project/contributing/build-and-release) -- [Upgrading Meshery](/installation/upgrades) -- [Running system checks using Meshery CLI](/guides/mesheryctl/running-system-checks-using-mesheryctl) -- [Troubleshooting Meshery Installations](/guides/troubleshooting/installation) +- [Install mesheryctl]({{< ref "installation/mesheryctl.md" >}}) +- [Install Meshery on Docker]({{< ref "installation/docker/_index.md" >}}) +- [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) +- [Install Docker Extension for Meshery]({{< ref "installation/docker/docker-extension/index.md" >}}) +- [Build & Release (CI)]({{< ref "project/contributing/build-and-release.md" >}}) +- [Upgrading Meshery]({{< ref "installation/upgrades/index.md" >}}) +- [Running system checks using Meshery CLI]({{< ref "guides/mesheryctl/running-system-checks-using-mesheryctl.md" >}}) +- [Troubleshooting Meshery Installations]({{< ref "guides/troubleshooting/installation/index.md" >}}) diff --git a/docs/content/en/installation/docker/_index.md b/docs/content/en/installation/docker/_index.md index da43905eec304..8d2de414df379 100644 --- a/docs/content/en/installation/docker/_index.md +++ b/docs/content/en/installation/docker/_index.md @@ -4,7 +4,7 @@ categories: [docker] aliases: - /installation/platforms/docker display_title: false -image: /installation/docker/images/docker.svg +image: installation/docker/images/docker.svg description: Install Meshery on Docker --- @@ -41,7 +41,7 @@ This is useful when: ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using [mesheryctl system check](/reference/mesheryctl/system/check). +Optionally, you can verify the health of your Meshery deployment using [mesheryctl system check]({{< ref "reference/mesheryctl/system/check.md" >}}). You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/docker/images/docker-desktop-meshery-extension-install.png b/docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-install.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-desktop-meshery-extension-install.png rename to docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-install.png diff --git a/docs/content/en/installation/docker/images/docker-desktop-meshery-extension-launch.png b/docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-launch.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-desktop-meshery-extension-launch.png rename to docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-launch.png diff --git a/docs/content/en/installation/docker/images/docker-desktop-meshery-extension-login.png b/docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-login.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-desktop-meshery-extension-login.png rename to docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-login.png diff --git a/docs/content/en/installation/docker/images/docker-desktop-meshery-extension-open.png b/docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-open.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-desktop-meshery-extension-open.png rename to docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-open.png diff --git a/docs/content/en/installation/docker/images/docker-desktop-meshery-extension-remove.png b/docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-remove.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-desktop-meshery-extension-remove.png rename to docs/content/en/installation/docker/docker-extension/images/docker-desktop-meshery-extension-remove.png diff --git a/docs/content/en/installation/docker/images/docker-hub-meshery-extension.png b/docs/content/en/installation/docker/docker-extension/images/docker-hub-meshery-extension.png similarity index 100% rename from docs/content/en/installation/docker/images/docker-hub-meshery-extension.png rename to docs/content/en/installation/docker/docker-extension/images/docker-hub-meshery-extension.png diff --git a/docs/content/en/installation/docker/docker-extension.md b/docs/content/en/installation/docker/docker-extension/index.md similarity index 77% rename from docs/content/en/installation/docker/docker-extension.md rename to docs/content/en/installation/docker/docker-extension/index.md index ae4edb98fed38..2b405b8c3ae15 100644 --- a/docs/content/en/installation/docker/docker-extension.md +++ b/docs/content/en/installation/docker/docker-extension/index.md @@ -4,18 +4,18 @@ categories: [docker] aliases: - /installation/platforms/docker-extension display_title: false -image: /installation/docker/images/docker.svg +image: installation/docker/images/docker.svg description: Install Docker Extension for Meshery --- -

        Quick Start with Docker Extension

        +

        Quick Start with Docker Extension

        The Docker Extension for Meshery extends Docker Desktop's position as the developer's go-to Kubernetes environment with easy access to the full capabilities of Meshery's collaborative cloud native management features. ## Prerequisites - You need Docker Desktop version of 4.10 or higher for this. -- This document applies only when Docker Desktop uses kubeadm with Kubernetes enabled. If you are using kind, please refer to the [Kind](installation/kubernetes/kind) section. +- This document applies only when Docker Desktop uses kubeadm with Kubernetes enabled. If you are using kind, please refer to the [Kind]({{< ref "installation/kubernetes/kinD/index.md" >}}) section. ## Install the Docker Meshery Extension @@ -35,19 +35,19 @@ Select one of the following three options to install the Docker Meshery Extensio Navigate to the **Extensions** marketplace of Docker Desktop. Search for Meshery and click the Install button to install the extension. -[![Docker Meshery Extension Install](/installation/docker/images/docker-desktop-meshery-extension-install.png)](/installation/docker/images/docker-desktop-meshery-extension-install.png) +[![Docker Meshery Extension Install](images/docker-desktop-meshery-extension-install.png)](images/docker-desktop-meshery-extension-install.png) Click **Open** when installation is done or click **Meshery** on the left under **Extensions**. -[![Docker Meshery Extension Open](/installation/docker/images/docker-desktop-meshery-extension-open.png)](/installation/docker/images/docker-desktop-meshery-extension-open.png) +[![Docker Meshery Extension Open](images/docker-desktop-meshery-extension-open.png)](images/docker-desktop-meshery-extension-open.png) Click **Login** to open the _Meshery Cloud_ login page. Log in or sign up and you will be redirected back to Docker Desktop. -[![Docker Meshery Extension Login](/installation/docker/images/docker-desktop-meshery-extension-login.png)](/installation/docker/images/docker-desktop-meshery-extension-login.png) +[![Docker Meshery Extension Login](images/docker-desktop-meshery-extension-login.png)](images/docker-desktop-meshery-extension-login.png) Finally, click **Launch Meshery** to load Meshery Dashboard in a browser window. It runs at http://localhost:9081/ by default. -[![Docker Meshery Extension Launch](/installation/docker/images/docker-desktop-meshery-extension-launch.png)](/installation/docker/images/docker-desktop-meshery-extension-launch.png) +[![Docker Meshery Extension Launch](images/docker-desktop-meshery-extension-launch.png)](images/docker-desktop-meshery-extension-launch.png) You can also open http://localhost:9081/ directly on a browser on the local machine after installing the Docker extension and complete the _Meshery Cloud_ login process to achieve the same result. @@ -55,7 +55,7 @@ You can also open http://localhost:9081/ directly on a browser on the local mach Another way to install the Meshery Docker Extension is from the Docker Hub. Navigate to the [Meshery Docker Extension](https://hub.docker.com/extensions/meshery/docker-extension-meshery) page and click Open in Docker Desktop to get started. Once installed, the rest of the process is same as above. -[![Docker Hub Extension](/installation/docker/images/docker-hub-meshery-extension.png)](/installation/docker/images/docker-hub-meshery-extension.png) +[![Docker Hub Extension](images/docker-hub-meshery-extension.png)](images/docker-hub-meshery-extension.png) ### Using Docker CLI @@ -93,7 +93,7 @@ You can remove the Docker Extension from the Docker Desktop interface or from th Navigate to **Manage** under Extensions, click the ellipsis button (three vertical dots) and select **Uninstall**. -[![Remove Meshery Docker Desktop Extension](/installation/docker/images/docker-desktop-meshery-extension-remove.png)](/installation/docker/images/docker-desktop-meshery-extension-remove.png) +[![Remove Meshery Docker Desktop Extension](images/docker-desktop-meshery-extension-remove.png)](images/docker-desktop-meshery-extension-remove.png) ### Removing using Docker CLI @@ -119,6 +119,6 @@ Meshery creates custom Docker networks, and they could still be left after the e {{< code code="docker network rm meshery_default" >}} - + -{{< related-discussions tag="meshery" >}} \ No newline at end of file +{{< related-discussions tag="meshery" >}} diff --git a/docs/content/en/installation/kubernetes/_index.md b/docs/content/en/installation/kubernetes/_index.md index 8c308f621ff33..5cf4728c57ec7 100644 --- a/docs/content/en/installation/kubernetes/_index.md +++ b/docs/content/en/installation/kubernetes/_index.md @@ -4,17 +4,17 @@ categories: [kubernetes] aliases: - /installation/platforms/kubernetes display_title: false -image: /installation/kubernetes/images/kubernetes.svg +image: installation/kubernetes/images/kubernetes.svg description: Install Meshery on Kubernetes. Deploy Meshery in Kubernetes in-cluster or outside of Kubernetes out-of-cluster. --- -

        Quick Start with Kubernetes

        +

        Quick Start with Kubernetes

        Manage your Kubernetes clusters with Meshery. Deploy Meshery in Kubernetes [in-cluster](#in-cluster-installation) or outside of Kubernetes [out-of-cluster](#out-of-cluster-installation). **_Note: It is advisable to install Meshery in your Kubernetes clusters_**

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Access to an active Kubernetes cluster.
        @@ -56,11 +56,11 @@ Before executing the below command, go to ~/.meshery/config.yaml and ensure that ## Installation: Using Helm -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/images/aks.svg b/docs/content/en/installation/kubernetes/aks/images/aks.svg similarity index 100% rename from docs/content/en/installation/kubernetes/images/aks.svg rename to docs/content/en/installation/kubernetes/aks/images/aks.svg diff --git a/docs/content/en/installation/kubernetes/aks.md b/docs/content/en/installation/kubernetes/aks/index.md similarity index 79% rename from docs/content/en/installation/kubernetes/aks.md rename to docs/content/en/installation/kubernetes/aks/index.md index add91a8519344..eb8686bc5b4f2 100644 --- a/docs/content/en/installation/kubernetes/aks.md +++ b/docs/content/en/installation/kubernetes/aks/index.md @@ -4,24 +4,24 @@ categories: [kubernetes] aliases: - /installation/platforms/aks display_title: false -image: /installation/kubernetes/images/aks.svg +image: installation/kubernetes/aks/images/aks.svg description: Manage your AKS clusters with Meshery. Deploy Meshery in AKS in-cluster or out-of-cluster. --- -

        Quick Start with AKS

        +

        Quick Start with AKS

        Manage your AKS clusters with Meshery. Deploy Meshery in AKS [in-cluster](#in-cluster-installation) or outside of AKS [out-of-cluster](#out-of-cluster-installation). **_Note: It is advisable to install Meshery in your AKS clusters_**

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Install Azure CLI, configured for your environment.
        5. Access to an active AKS cluster in one of your resource groups.
        -Also see: [Install Meshery on Kubernetes](/installation/kubernetes) +Also see: [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) ## Available Deployment Methods @@ -62,15 +62,15 @@ Once configured, execute the following command to start Meshery. {{< code code="mesheryctl system start" >}} -If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here](/guides/mesheryctl/authenticate-with-meshery-via-cli) to learn more. +If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here]({{< ref "guides/mesheryctl/authenticate-with-meshery-via-cli/index.md" >}}) to learn more. ### Installation: Using Helm -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment, using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment, using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/images/eks.png b/docs/content/en/installation/kubernetes/eks/images/eks.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/eks.png rename to docs/content/en/installation/kubernetes/eks/images/eks.png diff --git a/docs/content/en/installation/kubernetes/eks.md b/docs/content/en/installation/kubernetes/eks/index.md similarity index 82% rename from docs/content/en/installation/kubernetes/eks.md rename to docs/content/en/installation/kubernetes/eks/index.md index 976863c1329da..91dc3e0eca86a 100644 --- a/docs/content/en/installation/kubernetes/eks.md +++ b/docs/content/en/installation/kubernetes/eks/index.md @@ -4,24 +4,24 @@ categories: [kubernetes] aliases: - /installation/platforms/eks display_title: false -image: /installation/kubernetes/images/eks.png +image: installation/kubernetes/eks/images/eks.png description: Install Meshery on Elastic Kubernetes Service. Deploy Meshery in EKS in-cluster or outside of EKS out-of-cluster. --- -

        Quick Start with EKS

        +

        Quick Start with EKS

        Manage your EKS clusters with Meshery. Deploy Meshery in EKS [in-cluster](#in-cluster-installation) or outside of EKS [out-of-cluster](#out-of-cluster-installation). **_Note: It is advisable to install Meshery in your EKS clusters_**

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Install AWS CLI, configured for your environment.
        5. Access to an active EKS cluster in an AWS account.
        -Also see: [Install Meshery on Kubernetes](/installation/kubernetes) +Also see: [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) ### Available Deployment Methods @@ -50,17 +50,17 @@ Follow the steps below to install Meshery in your EKS cluster. ## Installation: Using `mesheryctl` -Execute mesheryctl system start command to start Meshery. +Execute mesheryctl system start command to start Meshery. {{< code code="mesheryctl system start" >}} ## Installation: Using Helm -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/images/gke.png b/docs/content/en/installation/kubernetes/gke/images/gke.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/gke.png rename to docs/content/en/installation/kubernetes/gke/images/gke.png diff --git a/docs/content/en/installation/kubernetes/gke.md b/docs/content/en/installation/kubernetes/gke/index.md similarity index 78% rename from docs/content/en/installation/kubernetes/gke.md rename to docs/content/en/installation/kubernetes/gke/index.md index b62dec4e13e9d..1179d264118e5 100644 --- a/docs/content/en/installation/kubernetes/gke.md +++ b/docs/content/en/installation/kubernetes/gke/index.md @@ -4,24 +4,24 @@ categories: [kubernetes] aliases: - /installation/platforms/gke display_title: false -image: /installation/kubernetes/images/gke.png +image: installation/kubernetes/gke/images/gke.png description: Install Meshery on Google Kubernetes Engine. Deploy Meshery in GKE in-cluster or outside of GKE out-of-cluster. --- -

        Quick Start with GKE

        +

        Quick Start with GKE

        Manage your GKE clusters with Meshery. Deploy Meshery in GKE [in-cluster](#in-cluster-installation) or outside of GKE [out-of-cluster](#out-of-cluster-installation). **_Note: It is advisable to install Meshery in your GKE clusters_**

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Install gcloud CLI, configured for your environment.
        5. Access to an active GKE cluster in your Google Cloud project.
        -Also see: [Install Meshery on Kubernetes](/installation/kubernetes) +Also see: [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) ## Available Deployment Methods @@ -57,8 +57,8 @@ Read through the following considerations prior to deploying Meshery on GKE. ### Preflight: Plan your access to Meshery UI -1. If you are using port-forwarding, please refer to the [port-forwarding](/reference/mesheryctl/system/dashboard) guide for detailed instructions. -2. If you are using a LoadBalancer, please refer to the [LoadBalancer](/installation/kubernetes#exposing-meshery-serviceloadbalancer) guide for detailed instructions. +1. If you are using port-forwarding, please refer to the [port-forwarding]({{< ref "reference/mesheryctl/system/dashboard.md" >}}) guide for detailed instructions. +2. If you are using a LoadBalancer, please refer to the [LoadBalancer]({{< ref "installation/kubernetes/_index.md#exposing-meshery-serviceloadbalancer" >}}) guide for detailed instructions. 3. Customize your Meshery Provider Callback URL. Meshery Server supports customizing authentication flow callback URL, which can be configured in the following way: {{< code code="MESHERY_SERVER_CALLBACK_URL=https://custom-host mesheryctl system start" >}} @@ -75,15 +75,15 @@ Once configured, execute the following command to start Meshery. {{< code code="mesheryctl system start" >}} -If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here](/guides/mesheryctl/authenticate-with-meshery-via-cli) to learn more. +If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here]({{< ref "guides/mesheryctl/authenticate-with-meshery-via-cli/index.md" >}}) to learn more. ## Installation: Using Helm -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/helm.md b/docs/content/en/installation/kubernetes/helm.md index c6d4b6e57ce99..a633ec9bc25b4 100644 --- a/docs/content/en/installation/kubernetes/helm.md +++ b/docs/content/en/installation/kubernetes/helm.md @@ -115,7 +115,7 @@ For comprehensive guidance on configuring health checks for different scenarios ## Post-Installation Steps -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/images/kind.png b/docs/content/en/installation/kubernetes/kinD/images/kind.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/kind.png rename to docs/content/en/installation/kubernetes/kinD/images/kind.png diff --git a/docs/content/en/installation/kubernetes/kinD.md b/docs/content/en/installation/kubernetes/kinD/index.md similarity index 85% rename from docs/content/en/installation/kubernetes/kinD.md rename to docs/content/en/installation/kubernetes/kinD/index.md index d12801e43140a..a6a0207869be8 100644 --- a/docs/content/en/installation/kubernetes/kinD.md +++ b/docs/content/en/installation/kubernetes/kinD/index.md @@ -4,23 +4,23 @@ categories: [kubernetes] aliases: - /installation/platforms/kind display_title: false -image: /installation/kubernetes/images/kind.png +image: installation/kubernetes/kinD/images/kind.png description: Install Meshery on KinD. Deploy Meshery in KinD in-cluster or outside of KinD out-of-cluster. --- -

        Quick Start with KinD

        +

        Quick Start with KinD

        Manage your KinD clusters with Meshery. Deploy Meshery in your [KinD cluster](#in-cluster-installation).

        Prerequisites

          -
        1. Install the Meshery command line client, mesheryctl.
          2. +
        2. Install the Meshery command line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Install KinD on your local machine.
        -Also see: [Install Meshery on Kubernetes](/installation/kubernetes) +Also see: [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) ## Available Deployment Methods @@ -78,7 +78,7 @@ With your KIND cluster configured as your `current-context`, start Meshery. ### Alternative Installation: Using Helm -See [Helm Installation](/installation/kubernetes/helm) guide. +See [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. ### Post-Installation Steps @@ -86,7 +86,7 @@ Meshery deploys with LoadBalancer service type by default. If you are using KinD {{% mesheryctl/system-dashboard %}} -Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. +Optionally, you can verify the health of your Meshery deployment using mesheryctl system check. You're ready to use Meshery! Open your browser and navigate to the Meshery UI. diff --git a/docs/content/en/installation/kubernetes/images/Meshery-app-running.png b/docs/content/en/installation/kubernetes/kubesphere/images/Meshery-app-running.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/Meshery-app-running.png rename to docs/content/en/installation/kubernetes/kubesphere/images/Meshery-app-running.png diff --git a/docs/content/en/installation/kubernetes/images/Meshery-info.png b/docs/content/en/installation/kubernetes/kubesphere/images/Meshery-info.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/Meshery-info.png rename to docs/content/en/installation/kubernetes/kubesphere/images/Meshery-info.png diff --git a/docs/content/en/installation/kubernetes/images/Meshery-install.png b/docs/content/en/installation/kubernetes/kubesphere/images/Meshery-install.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/Meshery-install.png rename to docs/content/en/installation/kubernetes/kubesphere/images/Meshery-install.png diff --git a/docs/content/en/installation/kubernetes/images/Meshery-service.png b/docs/content/en/installation/kubernetes/kubesphere/images/Meshery-service.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/Meshery-service.png rename to docs/content/en/installation/kubernetes/kubesphere/images/Meshery-service.png diff --git a/docs/content/en/installation/kubernetes/images/Meshery-yaml.png b/docs/content/en/installation/kubernetes/kubesphere/images/Meshery-yaml.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/Meshery-yaml.png rename to docs/content/en/installation/kubernetes/kubesphere/images/Meshery-yaml.png diff --git a/docs/content/en/installation/kubernetes/images/kubesphere.png b/docs/content/en/installation/kubernetes/kubesphere/images/kubesphere.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/kubesphere.png rename to docs/content/en/installation/kubernetes/kubesphere/images/kubesphere.png diff --git a/docs/content/en/installation/kubernetes/images/meshery-app.png b/docs/content/en/installation/kubernetes/kubesphere/images/meshery-app.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/meshery-app.png rename to docs/content/en/installation/kubernetes/kubesphere/images/meshery-app.png diff --git a/docs/content/en/installation/kubernetes/images/meshery-dashboard.png b/docs/content/en/installation/kubernetes/kubesphere/images/meshery-dashboard.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/meshery-dashboard.png rename to docs/content/en/installation/kubernetes/kubesphere/images/meshery-dashboard.png diff --git a/docs/content/en/installation/kubernetes/kubesphere.md b/docs/content/en/installation/kubernetes/kubesphere/index.md similarity index 78% rename from docs/content/en/installation/kubernetes/kubesphere.md rename to docs/content/en/installation/kubernetes/kubesphere/index.md index eb9fdac401580..5460074d45b95 100644 --- a/docs/content/en/installation/kubernetes/kubesphere.md +++ b/docs/content/en/installation/kubernetes/kubesphere/index.md @@ -4,7 +4,7 @@ categories: [kubernetes] aliases: - /installation/platforms/kubesphere display_title: false -image: /installation/kubernetes/images/kubesphere.png +image: installation/kubernetes/kubesphere/images/kubesphere.png description: Install Meshery on KubeSphere --- @@ -31,22 +31,22 @@ Perform the following steps in order: 1. On the **Overview** page of the project `demo-project`, click **App Store** in the upper-left corner. 2. Search for **Meshery** in the App Store, and click on the search result to open the app. - ![meshery-app](/installation/kubernetes/images/meshery-app.png) + ![meshery-app](images/meshery-app.png) 3. In the **App Information** page, click **Install** on the upper right corner. - ![meshery-install](/installation/kubernetes/images/Meshery-install.png) + ![meshery-install](images/Meshery-install.png) 4. In the App Settings page, set the application **Name**, **Location** (as your namespace), and **App Version**, then click **Next** on the upper right corner. - ![meshery-info](/installation/kubernetes/images/Meshery-info.png) + ![meshery-info](images/Meshery-info.png) 5. Configure the **values.yaml** file as needed, or click **Install** to use the default configuration. - ![meshery-yaml](/installation/kubernetes/images/Meshery-yaml.png) + ![meshery-yaml](images/Meshery-yaml.png) 6. Wait for the deployment to be finished. Upon completion, **Meshery** will be shown as **Running** in KubeSphere. - ![meshery-app-running](/installation/kubernetes/images/Meshery-app-running.png) + ![meshery-app-running](images/Meshery-app-running.png) @@ -56,10 +56,10 @@ Perform the following steps in order: 1. Go to **Services** and click the service name of Meshery. 2. In the **Resource Status** page, copy the **NodePort** of Meshery. - ![meshery-service](/installation/kubernetes/images/Meshery-service.png) + ![meshery-service](images/Meshery-service.png) 3. Access the Meshery Dashboard by entering **${NodeIP}:${NODEPORT}** in your browser. - ![meshery-dashboard](/installation/kubernetes/images/meshery-dashboard.png) + ![meshery-dashboard](images/meshery-dashboard.png) {{< related-discussions tag="meshery" >}} diff --git a/docs/content/en/installation/kubernetes/images/minikube-upload.png b/docs/content/en/installation/kubernetes/minikube/images/minikube-upload.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/minikube-upload.png rename to docs/content/en/installation/kubernetes/minikube/images/minikube-upload.png diff --git a/docs/content/en/installation/kubernetes/images/minikube.png b/docs/content/en/installation/kubernetes/minikube/images/minikube.png similarity index 100% rename from docs/content/en/installation/kubernetes/images/minikube.png rename to docs/content/en/installation/kubernetes/minikube/images/minikube.png diff --git a/docs/content/en/installation/kubernetes/minikube.md b/docs/content/en/installation/kubernetes/minikube/index.md similarity index 90% rename from docs/content/en/installation/kubernetes/minikube.md rename to docs/content/en/installation/kubernetes/minikube/index.md index b1ea314f48ce4..5fae5be6adf8b 100644 --- a/docs/content/en/installation/kubernetes/minikube.md +++ b/docs/content/en/installation/kubernetes/minikube/index.md @@ -4,11 +4,11 @@ categories: [kubernetes] aliases: - /installation/platforms/minikube display-title: false -image: /installation/kubernetes/images/minikube.png +image: installation/kubernetes/minikube/images/minikube.png description: Install Meshery on Minikube. Deploy Meshery in Minikube in-cluster or outside of Minikube out-of-cluster. --- -

        Quick Start with Minikube

        +

        Quick Start with Minikube

        Meshery can manage your minikube clusters and is particularly useful for multi-cluster management and deployments. @@ -25,14 +25,14 @@ After your cluster has been added as a connection, you can use Meshery to make i

        Prerequisites

          -
        1. Install the Meshery command-line client, mesheryctl.
          2. +
        2. Install the Meshery command-line client, }}" class="meshery-light">mesheryctl.
        3. Install kubectl on your local machine.
        4. Install Minikube on your local machine.
        5. Install Helm.
        -Also see: [Install Meshery on Kubernetes](/installation/kubernetes) +Also see: [Install Meshery on Kubernetes]({{< ref "installation/kubernetes/_index.md" >}}) ## Available Deployment Methods @@ -87,7 +87,7 @@ To verify your deployment, run: After deployment, access the Meshery UI using port forwarding, with the command: {{< code code="mesheryctl system dashboard --port-forward" >}} -For detailed instructions on port forwarding, refer to the [port-forwarding](/reference/mesheryctl/system/dashboard) guide. +For detailed instructions on port forwarding, refer to the [port-forwarding]({{< ref "reference/mesheryctl/system/dashboard.md" >}}) guide. By default, Meshery auto-detects your Minikube cluster and establishes a connection. However, if this doesn’t happen, you can connect by running the following command: @@ -95,12 +95,12 @@ By default, Meshery auto-detects your Minikube cluster and establishes a connect The `mesheryctl system config minikube` command properly configures and uploads your kubeconfig file to the Meshery UI. -Minikube KubeConfig Upload +Minikube KubeConfig Upload ## Installation: Using Helm You can deploy Meshery directly using the Helm CLI. -For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/kubernetes/helm) guide. +For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation]({{< ref "installation/kubernetes/helm.md" >}}) guide. # Out-of-cluster Installation @@ -180,7 +180,7 @@ If you experience any issues during installation, refer to the [Troubleshooting # Post-Installation Steps -Verify the health of your Meshery deployment, using mesheryctl system check. +Verify the health of your Meshery deployment, using mesheryctl system check. {{< installation/accessing-meshery-ui >}} diff --git a/docs/content/en/installation/linux-mac/_index.md b/docs/content/en/installation/linux-mac/_index.md index e9eb623d6c976..eb7dfb26b3413 100644 --- a/docs/content/en/installation/linux-mac/_index.md +++ b/docs/content/en/installation/linux-mac/_index.md @@ -4,13 +4,13 @@ categories: [mesheryctl] aliases: - /installation/platforms/linux-mac display_title: false -image: /installation/linux-mac/images/linux_mac.png +image: installation/linux-mac/images/linux_mac.png description: Install Meshery CLI on Linux or macOS --- # Overview -To set up and run Meshery on Linux or macOS, you will need to install `mesheryctl`. `mesheryctl` is the command-line interface (CLI) for Meshery. It is used to install, manage, and operate one or more Meshery deployments. `mesheryctl` can be installed via `bash`, is also available [directly](https://github.com/meshery/meshery/releases/latest), or through [Homebrew](/installation/linux-mac/brew) or [Scoop](/installation/windows/scoop). +To set up and run Meshery on Linux or macOS, you will need to install `mesheryctl`. `mesheryctl` is the command-line interface (CLI) for Meshery. It is used to install, manage, and operate one or more Meshery deployments. `mesheryctl` can be installed via `bash`, is also available [directly](https://github.com/meshery/meshery/releases/latest), or through [Homebrew]({{< ref "installation/linux-mac/brew/index.md" >}}) or [Scoop]({{< ref "installation/windows/scoop/index.md" >}}). # Brew @@ -31,7 +31,7 @@ Guides to using Meshery's various features and components. ### Installation Options - + 
           
        
@@ -35,7 +35,7 @@ If you are on a macOS or Linux system, you can download, install, and run both `
        {{% alert color="info" title="Meshery CLI" %}} -Meshery's command line interface, mesheryctl, can be installed in various ways. In addition to Bash, you can also use Brew or Scoop to install mesheryctl. Alternatively, mesheryctl is also available via direct download. +Meshery's command line interface, mesheryctl, can be installed in various ways. In addition to Bash, you can also use Brew or Scoop to install mesheryctl. Alternatively, mesheryctl is also available via direct download. {{% /alert %}} ## 2. Access Meshery @@ -43,7 +43,7 @@ Meshery's command line interface, mesheryctl, can be installed in < Your default browser will be opened and directed to Meshery's web-based user interface typically found at `http://localhost:9081`. {{% alert color="light" title="Accessing Meshery Server with Meshery UI" %}} -Meshery's web-based user interface is embedded in Meshery Server and is available as soon as Meshery starts. The location and port that Meshery UI is exposed varies depending upon your mode of deployment. See accessing Meshery UI for deployment-specific details. +Meshery's web-based user interface is embedded in Meshery Server and is available as soon as Meshery starts. The location and port that Meshery UI is exposed varies depending upon your mode of deployment. See accessing Meshery UI for deployment-specific details. {{% /alert %}} {{% alert color="light" title="Accessing Meshery Server with Meshery CLI" %}} @@ -52,7 +52,7 @@ Meshery's command line interface is a client of Meshery Server's REST API (just ## 3. Select a Provider -Select from the list of [Providers](/extensibility/providers) in order to log in to Meshery. Authenticate with your chosen Provider. +Select from the list of [Providers]({{< ref "reference/extensibility/providers/index.md" >}}) in order to log in to Meshery. Authenticate with your chosen Provider. @@ -61,7 +61,7 @@ Select from the list of [Providers](/extensibility/providers) in order to log in ## 4. Configure Connections to your Kubernetes Clusters **Out-of-Cluster Deployments** -If you have deployed Meshery out-of-cluster, Meshery Server will automatically attempt to connect to any available Kubernetes clusters found in your kubeconfig (under `$HOME/.kube/config`) and in kubeconfigs uploaded through Meshery UI. Meshery Server deploys [Meshery Operator](/concepts/architecture/operator), [MeshSync](/concepts/architecture/meshsync), and Broker into the `meshery` namespace (by default). +If you have deployed Meshery out-of-cluster, Meshery Server will automatically attempt to connect to any available Kubernetes clusters found in your kubeconfig (under `$HOME/.kube/config`) and in kubeconfigs uploaded through Meshery UI. Meshery Server deploys [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}), [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}), and Broker into the `meshery` namespace (by default). **In-Cluster Deployments** If you have deployed Meshery in-cluster, Meshery Server will automatically connect to the Kubernetes API Server available in the control plane. @@ -72,11 +72,11 @@ Visit Settings: -If your config has not been autodetected, you can manually upload your kubeconfig file (or any number of kubeconfig files). By default, Meshery will attempt to connect to and deploy Meshery Operator to each reachable context contained in the imported kubeconfig files. See [Managing Kubernetes Clusters](/installation/kubernetes) for more information. +If your config has not been autodetected, you can manually upload your kubeconfig file (or any number of kubeconfig files). By default, Meshery will attempt to connect to and deploy Meshery Operator to each reachable context contained in the imported kubeconfig files. See [Managing Kubernetes Clusters]({{< ref "installation/kubernetes/_index.md" >}}) for more information. ## 5. Verify Deployment -Run connectivity tests and verify the health of your Meshery system. Verify Meshery's connection to your Kubernetes clusters by clicking on the connection chip. A quick connectivity test will run and inform you of Meshery's ability to reach and authenticate to your Kubernetes control plane(s). You will be notified of your connection status. You can also verify any other connection between Meshery and either its components (like [Meshery Adapters](/concepts/architecture/adapters)) or other managed infrastructure by clicking on any of the connection chips. When clicked, a chip will perform an ad hoc connectivity test. +Run connectivity tests and verify the health of your Meshery system. Verify Meshery's connection to your Kubernetes clusters by clicking on the connection chip. A quick connectivity test will run and inform you of Meshery's ability to reach and authenticate to your Kubernetes control plane(s). You will be notified of your connection status. You can also verify any other connection between Meshery and either its components (like [Meshery Adapters]({{< ref "concepts/architecture/adapters.md" >}})) or other managed infrastructure by clicking on any of the connection chips. When clicked, a chip will perform an ad hoc connectivity test. @@ -84,7 +84,7 @@ Run connectivity tests and verify the health of your Meshery system. Verify Mesh ## 6. Design and operate Kubernetes clusters and their workloads -You may now proceed to manage any cloud native infrastructure supported by Meshery. See all [integrations](/extensibility/integrations) for a complete list of supported infrastructure. +You may now proceed to manage any cloud native infrastructure supported by Meshery. See all [integrations]({{< ref "extensions/models/_index.md" >}}) for a complete list of supported infrastructure. @@ -100,8 +100,8 @@ You may now proceed to manage any cloud native infrastructure supported by Meshe
        -
        \ No newline at end of file +
        diff --git a/docs/content/en/installation/upgrades/index.md b/docs/content/en/installation/upgrades/index.md index 4cc7496c7cd34..dba268b37806e 100644 --- a/docs/content/en/installation/upgrades/index.md +++ b/docs/content/en/installation/upgrades/index.md @@ -68,7 +68,7 @@ Docker Deployment: Watchtower updates this component in accordance with the user - Remote Providers + }}">Remote Providers Meshery Cloud Process Extension: Integrators manage the lifecycle of their Remote Providers. The process is unique per provider. diff --git a/docs/content/en/installation/windows/_index.md b/docs/content/en/installation/windows/_index.md index e6a2b7bd3ed55..da3d05a7f91e4 100644 --- a/docs/content/en/installation/windows/_index.md +++ b/docs/content/en/installation/windows/_index.md @@ -3,7 +3,7 @@ title: Install Meshery CLI on Windows categories: [mesheryctl] aliases: - /installation/platforms/windows -image: /installation/windows/images/wsl2.png +image: installation/windows/images/wsl2.png description: Install Meshery CLI on Windows --- diff --git a/docs/content/en/installation/windows/images/scoop.png b/docs/content/en/installation/windows/scoop/images/scoop.png similarity index 100% rename from docs/content/en/installation/windows/images/scoop.png rename to docs/content/en/installation/windows/scoop/images/scoop.png diff --git a/docs/content/en/installation/windows/scoop.md b/docs/content/en/installation/windows/scoop/index.md similarity index 87% rename from docs/content/en/installation/windows/scoop.md rename to docs/content/en/installation/windows/scoop/index.md index b102513075f7c..1bed63ccc6906 100644 --- a/docs/content/en/installation/windows/scoop.md +++ b/docs/content/en/installation/windows/scoop/index.md @@ -4,7 +4,7 @@ categories: [mesheryctl] aliases: - /installation/platforms/scoop display_title: false -image: /installation/windows/images/scoop.png +image: installation/windows/scoop/images/scoop.png description: Install Meshery CLI on Windows with Scoop --- # Install Meshery CLI with Scoop diff --git a/docs/content/en/project/FAQ.md b/docs/content/en/project/FAQ.md index 7068e9f86aef2..b4d50ec7564d9 100644 --- a/docs/content/en/project/FAQ.md +++ b/docs/content/en/project/FAQ.md @@ -39,14 +39,14 @@ categories: [project]
        Question: Is Meshery an open source project?
         -

        Answer: Yes, Meshery is a Cloud Native Computing Foundation (CNCF) project and is licensed under Apache v2. As an internal developer platform, Meshery is highly extensible, offering multiple forms of extension points within which users and partners can customize and extend Meshery's functionality.

        +

        Answer: Yes, Meshery is a Cloud Native Computing Foundation (CNCF) project and is licensed under Apache v2. As an internal developer platform, Meshery is }}">highly extensible, offering multiple forms of extension points within which users and partners can customize and extend Meshery's functionality.

      Question: Why should I use Meshery?
       -

      Answer: Meshery is a powerful tool for managing Kubernetes infrastructure. It seamlessly integrates with hundreds of tools and offers extensibility through many different extension points. With Meshery, you can easily discover your environment, collaboratively manage multiple Kubernetes clusters, connect your Git and Helm repos, and analyze app and infra performance.

      +

      Answer: Meshery is a powerful tool for managing Kubernetes infrastructure. It seamlessly integrates with hundreds of tools and offers extensibility through many different }}">extension points. With Meshery, you can easily discover your environment, collaboratively manage multiple Kubernetes clusters, connect your Git and Helm repos, and analyze app and infra performance.

      @@ -63,12 +63,12 @@ categories: [project]
      Question: How do I install Meshery?
       -

      Answer: Meshery runs on a number of platforms. You are encouraged to use mesheryctl to configure and control Meshery deployments. Install `mesheryctl` using any of these options:

      +

      Answer: Meshery runs on a }}">number of platforms. You are encouraged to use mesheryctl to configure and control Meshery deployments. Install `mesheryctl` using any of these options:

    @@ -83,12 +83,12 @@ categories: [project]
  • Configure and manage non-Kubernetes infrastructure (like AWS and GCP services)
  • Use Kubernetes operators to manage Cloud services outside of Kubernetes (e.g. AWS EC2)
-

See supported cloud integrations for more details.

+

See }}">supported cloud integrations for more details.

Question: What architecture does Meshery have?
 -

Answer: An extensible architecture. There are several components and languages, and they have different purposes. See Meshery's Architecture.

+

Answer: An extensible architecture. There are several components and languages, and they have different purposes. See Meshery's }}">Architecture.

@@ -102,7 +102,7 @@ categories: [project]
Question: What systems can I deploy Meshery onto?
 -Answer: Many. See Meshery's Compatibility Matrix. +Answer: Many. See Meshery's }}">Compatibility Matrix.
@@ -145,7 +145,7 @@ categories: [project]
  • If you don't see the specific entities in Meshery UI, you may choose to reset Meshery's database. This option is in the Reset System Tab in Settings page.
    • -

    Note: You can also verify the health of your system using mesheryctl system check

    +

    Note: You can also verify the health of your system using }}">mesheryctl system check

    @@ -154,7 +154,7 @@ categories: [project]
    Question: Getting an error while running make server on Windows? -Answer:

    On Windows, set up the project on Ubuntu WSL2 and you will be able to run the Meshery UI and the server. For more information please visit Setting up Meshery Development Environment on Windows.

    +Answer:

    On Windows, set up the project on Ubuntu WSL2 and you will be able to run the Meshery UI and the server. For more information please visit }}">Setting up Meshery Development Environment on Windows.

    {{< discuss >}} diff --git a/docs/content/en/project/community.md b/docs/content/en/project/community.md index dd2ebdd7be33b..2c86a01c16c22 100644 --- a/docs/content/en/project/community.md +++ b/docs/content/en/project/community.md @@ -10,7 +10,7 @@ Meshery is a CNCF project maintained by engineers from Layer5, VMware, Red Hat, Get involved with Meshery and supporting projects. Start by reading through the [Newcomers Guide](https://meshery.io/community), which provides details on how to participate. Seek out other community members, who will make sure you are not left out. We always have a role for everyone whether to be a code-writer, a community manager, user, advocate, or just to listen in. The Meshery community is always open and warmly welcomes you. If this is your first time making open source contribution, you are in the right place! -Please see our [contributing guide](/project/contributing) for specific details about setting up your development environment and to start learning the innerworkings of a specific Meshery component. +Please see our [contributing guide]({{< ref "project/contributing/_index.md" >}}) for specific details about setting up your development environment and to start learning the innerworkings of a specific Meshery component. #### Community First diff --git a/docs/content/en/project/contributing/_index.md b/docs/content/en/project/contributing/_index.md index 8db06b6ab0ff5..3d837f5d0ee57 100644 --- a/docs/content/en/project/contributing/_index.md +++ b/docs/content/en/project/contributing/_index.md @@ -13,7 +13,7 @@ Please do! Thanks for your help! 🎈 Meshery is community-built and welcomes co Meshery and it's various architectural components are written in different languages, including Golang, Javascript (React.js and Next.js) To make building, testing, and the experience of contributing consistent across all Meshery components, a `Makefile` is included in the every repository. These `make` targets are what you will use to build, run, test, and document. -To contribute to Meshery, please follow this basic fork-and-pull request [gitflow](/project/contributing/contributing-gitflow). +To contribute to Meshery, please follow this basic fork-and-pull request [gitflow]({{< ref "project/contributing/contributing-gitflow.md" >}}).
    Adding your sign-off on commits (Developer Certificate of Origin) diff --git a/docs/content/en/project/contributing/build-and-release.md b/docs/content/en/project/contributing/build-and-release.md index 0c9bd781e6147..38371baa20cec 100644 --- a/docs/content/en/project/contributing/build-and-release.md +++ b/docs/content/en/project/contributing/build-and-release.md @@ -236,7 +236,7 @@ Meshery and its components follow the commonly used, semantic versioning for its ### Component Versioning -Meshery comprises a number of components including a server, adapters, UI, and CLI. As an application, Meshery is a composition of these different functional components. While all of Meshery’s components generally deploy as a collective unit (together), each component is versioned independently, so as to allow them to be loosely coupled and iterate on functionality independently. Some of the components must be upgraded simultaneously, while others may be upgraded independently. See [Upgrading Meshery](/installation/upgrades) for more information. +Meshery comprises a number of components including a server, adapters, UI, and CLI. As an application, Meshery is a composition of these different functional components. While all of Meshery’s components generally deploy as a collective unit (together), each component is versioned independently, so as to allow them to be loosely coupled and iterate on functionality independently. Some of the components must be upgraded simultaneously, while others may be upgraded independently. See [Upgrading Meshery]({{< ref "installation/upgrades/index.md" >}}) for more information. GitHub release tags will contain a semantic version number. Semantic version numbers will have to be managed manually by tagging a relevant commit in the master branch with a semantic version number (example: v1.2.3). diff --git a/docs/content/en/project/contributing/contributing-adapters.md b/docs/content/en/project/contributing/contributing-adapters.md index f0cfadee57f91..1198133f6ff5c 100644 --- a/docs/content/en/project/contributing/contributing-adapters.md +++ b/docs/content/en/project/contributing/contributing-adapters.md @@ -5,11 +5,11 @@ categories: [contributing] --- -Meshery Adapters are the Extension Points in Meshery's architecture. Their design, the process of creating a new adapter is documented in [Extensibility: Meshery Adapters](/extensibility/adapters). +Meshery Adapters are the Extension Points in Meshery's architecture. Their design, the process of creating a new adapter is documented in [Extensibility: Meshery Adapters]({{< ref "extensions/adapters/_index.md" >}}). With the [CONTRIBUTING.md](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#adapter) in mind, understand that development follows the usual fork-and-pull request workflow described here, see also GitHub Process. On forking GitHub deactivates all workflows. It is safe and good practice to activate them such that the code is validated on each push. This requires that branches filter for β€œon push” is set to β€˜**’ to be triggered also on branches containing β€˜/’ in their name. The actions are parameterized using secrets (see Build & Release Strategy). The Docker image is only built and pushed to Docker Hub if a tag is pushed and the corresponding authentication information is configured. -Each commit has to be signed off, see [Contributing Overview](/project/contributing). +Each commit has to be signed off, see [Contributing Overview]({{< ref "project/contributing/_index.md" >}}). ### Running an adapter as a container diff --git a/docs/content/en/project/contributing/contributing-cli-guide.md b/docs/content/en/project/contributing/contributing-cli-guide.md index 7cbaa55349958..52b89ebb372c6 100644 --- a/docs/content/en/project/contributing/contributing-cli-guide.md +++ b/docs/content/en/project/contributing/contributing-cli-guide.md @@ -72,7 +72,7 @@ The following table outlines a set of design artifacts produced in the process o | **Document** | **Purpose** | | --- | --- | -| [mesheryctl Command Reference](/reference/mesheryctl) | Overarching index in the form of succinct, categorized, and tabularly displayed reference of all commands and their syntax with simple example usage. | +| [mesheryctl Command Reference]({{< ref "reference/mesheryctl/_index.md" >}}) | Overarching index in the form of succinct, categorized, and tabularly displayed reference of all commands and their syntax with simple example usage. | | `mesheryctl ` | Breakout of individual command purpose, syntax, flags, and behavior. Links to these separate, breakout documents should be available from the mesheryctl Command Reference. | ## Designing Commands diff --git a/docs/content/en/project/contributing/contributing-cli-tests.md b/docs/content/en/project/contributing/contributing-cli-tests.md index af5bc5ffb264f..4ddfa1e856f04 100644 --- a/docs/content/en/project/contributing/contributing-cli-tests.md +++ b/docs/content/en/project/contributing/contributing-cli-tests.md @@ -4,13 +4,13 @@ description: How to contribute to Meshery Command Line Interface end-to-end test categories: [contributing] --- -Meshery CLI is the command line interface for Meshery. Meshery CLI, otherwise known as `mesheryctl`, is a client of Meshery Server's [REST API](/extensibility/api). It provides a way to interact with Meshery and perform various operations such as installing, configuring, and managing cloud native infrastructure. +Meshery CLI is the command line interface for Meshery. Meshery CLI, otherwise known as `mesheryctl`, is a client of Meshery Server's [REST API]({{< ref "reference/extensibility/api.md" >}}). It provides a way to interact with Meshery and perform various operations such as installing, configuring, and managing cloud native infrastructure. This document is intended to help you contribute to the end-to-end tests for `mesheryctl`, the Meshery CLI. It is designed to be a guide for developers who are new to the project and want to contribute to the testing of `mesheryctl`. The end-to-end tests for `mesheryctl` are designed to ensure that the CLI is working as expected and that it is compatible with the various cloud native infrastructure and public cloud services that Meshery supports. These tests are run automatically on every pull request to ensure that any changes made to the code do not break the existing functionality of the CLI. -{{% alert color="info" title="Meshery CLI Reference Documents" %}}
    • Contributing to Meshery CLI
    • Meshery Command Tracker: Status of mesheryctl command implementation and platform compatibility.
      • +{{% alert color="info" title="Meshery CLI Reference Documents" %}}{{% /alert %}} @@ -73,7 +73,7 @@ There are a few ways to set up the Meshery server, but for end-to-end testing, w make server ``` -Be aware that some test cases require the availability of a Kubernetes cluster and one or more Meshery Adapters. In those cases, please refer to the [installation guides](/installation)) (like that of [installing Meshery on Minikube](/installation/kubernetes/minikube)). +Be aware that some test cases require the availability of a Kubernetes cluster and one or more Meshery Adapters. In those cases, please refer to the [installation guides]({{< ref "installation/_index.md" >}})) (like that of [installing Meshery on Minikube]({{< ref "installation/kubernetes/minikube/index.md" >}})). ### Authentication @@ -119,7 +119,7 @@ The tests will be available in[`mesheryctl/tests/e2e`](https://github.com/mesher ### Test Case Naming Convention -Bats will run the tests sequentially so we use a prefix code alphanumeric to be able to order tests as required when necessary. The prefix code is used to order the tests in a way that makes sense for the command under test. The prefix code is used to group the tests by command and subcommand. The prefix code is also used to order the tests within the command and subcommand. For example, you need to import a [Meshery Model](/concepts/logical/models) before being able to view the details of that model +Bats will run the tests sequentially so we use a prefix code alphanumeric to be able to order tests as required when necessary. The prefix code is used to order the tests in a way that makes sense for the command under test. The prefix code is used to group the tests by command and subcommand. The prefix code is also used to order the tests within the command and subcommand. For example, you need to import a [Meshery Model]({{< ref "concepts/logical/models/index.md" >}}) before being able to view the details of that model **Test Folder** - **prefix**: 3 digits alphanumeric code @@ -215,7 +215,7 @@ To filter and view only CLI-related test cases using the Sheet Views feature: 1. In the top menu bar, click Data β†’ Change view 2. Choose the pre-defined view labeled "CLI" -![Meshery Test Plan Screenshot](/project/contributing/images/meshery-test-plan-v0.8.0-ui.png) +![Meshery Test Plan Screenshot](../images/meshery-test-plan-v0.8.0-ui.png) ## Development diff --git a/docs/content/en/project/contributing/images/patternApply.png b/docs/content/en/project/contributing/contributing-cli/images/patternApply.png similarity index 100% rename from docs/content/en/project/contributing/images/patternApply.png rename to docs/content/en/project/contributing/contributing-cli/images/patternApply.png diff --git a/docs/content/en/project/contributing/contributing-cli.md b/docs/content/en/project/contributing/contributing-cli/index.md similarity index 87% rename from docs/content/en/project/contributing/contributing-cli.md rename to docs/content/en/project/contributing/contributing-cli/index.md index e18b4afc9a17e..9e90e2dcca0ce 100644 --- a/docs/content/en/project/contributing/contributing-cli.md +++ b/docs/content/en/project/contributing/contributing-cli/index.md @@ -14,7 +14,7 @@ categories: [contributing] ### Designing Commands -The [Meshery CLI Style Guide](/project/contributing/contributing-cli-guide) outlines the process by which new commands are designed and contains a collection of principles and conventions that need to be followed while designing `mesheryctl` commands. `mesheryctl` might be the interface that the users first have with Meshery. As such, `mesheryctl` needs to provide a great UX. +The [Meshery CLI Style Guide]({{< ref "project/contributing/contributing-cli-guide.md" >}}) outlines the process by which new commands are designed and contains a collection of principles and conventions that need to be followed while designing `mesheryctl` commands. `mesheryctl` might be the interface that the users first have with Meshery. As such, `mesheryctl` needs to provide a great UX. ### Building CLI @@ -32,7 +32,7 @@ For logs, `mesheryctl` uses [MeshKit](https://github.com/meshery/meshkit). ### Documenting -The documentation pages for `mesheryctl` reference are made with the help of the Cobra Golang framework and use of GitHub Actions. The [Meshery CLI Reference](/reference/mesheryctl) is autogenerated based on docs sections in each of `mesheryctl`'s Golang files. Meshery CLI Reference pages are updated each time a change to its respective `mesheryctl` Golang file is merged into the project's `master` branch. This approach to documentation facilitates a single source of truth for CLI syntax and command behavior, which results in higher quality reference and a reduction in the toil involved in keeping documentation up-to-date. To contribute to the Meshery CLI Reference, follow these steps: +The documentation pages for `mesheryctl` reference are made with the help of the Cobra Golang framework and use of GitHub Actions. The [Meshery CLI Reference]({{< ref "reference/mesheryctl/_index.md" >}}) is autogenerated based on docs sections in each of `mesheryctl`'s Golang files. Meshery CLI Reference pages are updated each time a change to its respective `mesheryctl` Golang file is merged into the project's `master` branch. This approach to documentation facilitates a single source of truth for CLI syntax and command behavior, which results in higher quality reference and a reduction in the toil involved in keeping documentation up-to-date. To contribute to the Meshery CLI Reference, follow these steps: - Go to the required command file in which the documentation has to be created/updated (mainly under /mesheryctl/internal/cli/root/...) - Then, edit the Cobra macro variables present in the each file. An example is given below for reference. @@ -56,7 +56,7 @@ Annotations: linkScreenshot, Also, if the screenshot is present in the command, an `Annotation` macro variable (of `map[string]string` type) containing the `link` and the `caption` has to be added at the bottom of the `Examples` field in the command file. The image file has to be included in the `docs/content/en/reference/images` folder in **PNG** format. The screenshot field is given for reference below {{< code code=`var linkDocPatternApply = map[string]string{ - "link": "![pattern-apply-usage](/reference/images/patternApply.png)", + "link": "![pattern-apply-usage](images/patternApply.png)", "caption": "Usage of mesheryctl design apply", } ... @@ -73,7 +73,7 @@ Annotations: linkDocPatternApply, ### Adding New/Removing Existing commands in the reference index -Though the command page is generated automatically by the Cobra CLI library, there are chances where the command does not appear in the [reference index page](/reference/mesheryctl). In such cases, the command details must be manually added to the reference index YAML file. This is generally done by editing the below two files: +Though the command page is generated automatically by the Cobra CLI library, there are chances where the command does not appear in the [reference index page]({{< ref "reference/mesheryctl/_index.md" >}}). In such cases, the command details must be manually added to the reference index YAML file. This is generally done by editing the below two files: - [cmds.yml](https://github.com/meshery/meshery/blob/master/docs/data/mesheryctlcommands/cmds.yml) - The YAML file containing the data about the commands - [_index.md](https://github.com/meshery/meshery/blob/master/docs/content/en/reference/mesheryctl/_index.md) - The markdown page of the command reference documentation @@ -171,4 +171,4 @@ To update golden files with the test output use the `--update` flag: #### End-to-end Tests -End-to-end testing of mesheryctl uses the Bash Automated Testing System (BATS) framework to define and execute CLI tests. See [Contributing to Meshery CLI End-to-End Tests](/project/contributing/contributing-cli-tests) +End-to-end testing of mesheryctl uses the Bash Automated Testing System (BATS) framework to define and execute CLI tests. See [Contributing to Meshery CLI End-to-End Tests]({{< ref "project/contributing/contributing-cli-tests.md" >}}) diff --git a/docs/content/en/project/contributing/contributing-components.md b/docs/content/en/project/contributing/contributing-components.md index ad50c332eb9a9..d5107f2296e21 100644 --- a/docs/content/en/project/contributing/contributing-components.md +++ b/docs/content/en/project/contributing/contributing-components.md @@ -3,9 +3,9 @@ title: Contributing to Model Components description: How to contribute to Meshery Model Components categories: [contributing] --- -**Components are defined by schemas.** Each component's structure, capabilities, and metadata follow the [Component schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/component) in `meshery/schemas`. When creating or modifying components, ensure they conform to the schema specification. See [Contributing to Schemas](/project/contributing/contributing-schemas) for details. +**Components are defined by schemas.** Each component's structure, capabilities, and metadata follow the [Component schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/component) in `meshery/schemas`. When creating or modifying components, ensure they conform to the schema specification. See [Contributing to Schemas]({{< ref "project/contributing/contributing-schemas.md" >}}) for details. -In Meshery, a [Components](/concepts/logical/components) is a fundamental building block used to represent and define the infrastructure under management. Each component provides granular and specific support for your infrastructure and applications. Once registered with Meshery Server (in the [Registry](/concepts/logical/registry)), components are available for inclusion in [Designs](/concepts/logical/designs) that you create. Components can be created and published by anyone, allowing you to share you custom extensions with the community. +In Meshery, a [Components]({{< ref "concepts/logical/components.md" >}}) is a fundamental building block used to represent and define the infrastructure under management. Each component provides granular and specific support for your infrastructure and applications. Once registered with Meshery Server (in the [Registry]({{< ref "concepts/logical/registry.md" >}})), components are available for inclusion in [Designs]({{< ref "concepts/logical/designs.md" >}}) that you create. Components can be created and published by anyone, allowing you to share you custom extensions with the community. ## Overview of Steps to Create Components @@ -28,7 +28,7 @@ In Meshery, a [Components](/concepts/logical/components) is a fundamental buildi ### 1. Understand Model Generation and Packaging -{{% alert color="warning" title="Prerequisite Reading" %}}Components are defined and packaged in context of a Model. Be sure to first read and understand how models are created and packaged before attempting to create a new component. Without a model defined first, they component will be homeless.{{% /alert %}} +{{% alert color="warning" title="Prerequisite Reading" %}}Components are defined and packaged in context of a Model. Be sure to first read and understand how models are created and packaged before attempting to create a new component. Without a model defined first, they component will be homeless.{{% /alert %}} @@ -57,7 +57,7 @@ Meshery contributors who want to customize the visual representation of a Mesher * **Primary Color**: The primary color used for the component in hex format. * **Secondary Color**: The secondary color used for the component in hex format. * **Shape**: The basic shape of the component, such as a circle or square. -* **isAnnotation**: A boolean value that indicates whether the component is an annotation or is [semantically meaningful](/concepts/logical/components). +* **isAnnotation**: A boolean value that indicates whether the component is an annotation or is [semantically meaningful]({{< ref "concepts/logical/components.md" >}}).
      Example Component Metadata @@ -98,7 +98,7 @@ Component icons will be written to the `/meshmodel/components//icon/ ### 3. Create a Component Definition as a JSON file -Create a relationship definition as a JSON file, placing this new definition file into its respective model folder (see [Contributing to Models](/project/contributing/contributing-models)). Relationship definition files are commonly named `relationships.yaml` as a convention, however, this name is not required. A model may include any number of relationship definitions. Include the following attributes in your relationship definition: +Create a relationship definition as a JSON file, placing this new definition file into its respective model folder (see [Contributing to Models]({{< ref "project/contributing/contributing-models/index.md" >}})). Relationship definition files are commonly named `relationships.yaml` as a convention, however, this name is not required. A model may include any number of relationship definitions. Include the following attributes in your relationship definition: - `kind`: The genre of component (e.g., `Pod`). - `model`: The model to which the component belongs (e.g., `kubernetes`). @@ -126,4 +126,4 @@ Submit a pull request to the Meshery repository with your new component definiti Keeping your component definition in a separate file allows for easier management and review of the component(s) you have defined. -{{% alert color="info" title="Keeping your custom Components private" %}}Alternatively, if you would like to keep the component definition private, you can bundle your component(s) in a custom model, import the custom model into your Meshery deployment. Your private component definition(s) will be registered in your Meshery Server's registry and available for use within your Meshery deployment.{{% /alert %}} +{{% alert color="info" title="Keeping your custom Components private" %}}Alternatively, if you would like to keep the component definition private, you can bundle your component(s) in a custom model, import the custom model into your Meshery deployment. Your private component definition(s) will be registered in your Meshery Server's registry and available for use within your Meshery deployment.{{% /alert %}} diff --git a/docs/content/en/project/contributing/images/docker-extension-browse.png b/docs/content/en/project/contributing/contributing-docker-extension/images/docker-extension-browse.png similarity index 100% rename from docs/content/en/project/contributing/images/docker-extension-browse.png rename to docs/content/en/project/contributing/contributing-docker-extension/images/docker-extension-browse.png diff --git a/docs/content/en/project/contributing/images/docker-extension.png b/docs/content/en/project/contributing/contributing-docker-extension/images/docker-extension.png similarity index 100% rename from docs/content/en/project/contributing/images/docker-extension.png rename to docs/content/en/project/contributing/contributing-docker-extension/images/docker-extension.png diff --git a/docs/content/en/project/contributing/contributing-docker-extension.md b/docs/content/en/project/contributing/contributing-docker-extension/index.md similarity index 88% rename from docs/content/en/project/contributing/contributing-docker-extension.md rename to docs/content/en/project/contributing/contributing-docker-extension/index.md index efcba51d4da3b..02519f32d3877 100644 --- a/docs/content/en/project/contributing/contributing-docker-extension.md +++ b/docs/content/en/project/contributing/contributing-docker-extension/index.md @@ -16,14 +16,14 @@ The Docker Extension for Meshery extends Docker Desktop’s position as the clou 2) From the Dashboard, select Add Extensions in the menu bar or open the Extensions Marketplace from the menu options. - - + + 3) Navigate to Meshery in the Marketplace and press install. - - + + OR diff --git a/docs/content/en/project/contributing/contributing-docs.md b/docs/content/en/project/contributing/contributing-docs.md index 6b76d6b3050ea..35e61ecc42429 100644 --- a/docs/content/en/project/contributing/contributing-docs.md +++ b/docs/content/en/project/contributing/contributing-docs.md @@ -230,13 +230,13 @@ Whenever the code tags are detected, the clipboard javascript file is automatica ## Documentation Contribution Flow Summary {{% alert color="light" title="Note" %}} -For contributing `mesheryctl` reference section, refer [Contributing CLI](/project/contributing/contributing-cli) +For contributing `mesheryctl` reference section, refer [Contributing CLI]({{< ref "project/contributing/contributing-cli/index.md" >}}) {{% /alert %}} The following is a concise summary of the steps to contribute to Meshery documentation. -1. Create a fork, if you have not already, by following the steps described [here](CONTRIBUTING-gitflow.md) +1. Create a fork, if you have not already, by following the steps described [here]({{< ref "project/contributing/contributing-gitflow.md" >}}) 2. In the local copy of your fork, navigate to the docs folder. `cd docs` 3. Create and checkout a new branch to make changes within @@ -372,11 +372,17 @@ Other supported alert colors include `warning`, `danger`,`success`,`primary`, `s Control image display in documentation pages using the following methods. +Use the following URL handling rules when linking documentation resources: + +- Content page: use `ref`. +- Page-bundle asset adjacent to `index.md` or `_index.md`: use a relative path, such as `images/foo.webp`. +- Global shared asset under `static/`: use the `static` shortcode, such as `{{}}`. + #### Default Image Size in Markdown Format Using the Markdown image syntax: -{{< code code="[![Image Title](/assets/img/your-image.png)](/assets/img/your-image.png)" >}} +{{< code code=`[![Image Title]({{}})]({{}})` >}} This renders as: @@ -412,7 +418,7 @@ You can include block quotes to emphasize text. ### Adding Integration Specific Information to Individual Integration Pages -Integration pages ([example](/extensibility/integrations/aws)) are automatically generated, however, integration specific documentation is often needed. +Integration pages ([example]({{< ref "extensions/models/aws/index.md" >}})) are automatically generated, however, integration specific documentation is often needed. [modelscustominfo](https://github.com/meshery/meshery/tree/master/docs/data/modelscustominfo) collection holds custom markdown files. Follow these steps: @@ -434,7 +440,7 @@ title: Azure Active Directory (AAD) ``` In this example, the heading "Azure Active Directory" will be displayed on the integration page: -[Azure Active Directory Integration Page](/extensibility/integrations/aad-pod-identity) +[Azure Active Directory Integration Page]({{< ref "extensions/models/aad-pod-identity/index.md" >}}) ### Suggested Reading diff --git a/docs/content/en/project/contributing/contributing-error.md b/docs/content/en/project/contributing/contributing-error.md index bc8d73e4617b8..2321b4abc3f10 100644 --- a/docs/content/en/project/contributing/contributing-error.md +++ b/docs/content/en/project/contributing/contributing-error.md @@ -6,7 +6,7 @@ categories: [contributing] Meshery pervasively uses MeshKit as a golang and infrastructure management-specific library in all of its components. MeshKit helps populate error messages with a uniform and useful set of informative attributes. -To help with creating error codes, MeshKit contains a tool that analyzes, verifies and updates error codes in Meshery source code trees. It extracts error details into a file that can be used for publishing all error code references on the Meshery [error codes reference page](/reference/error-codes). The objective to create this was to avoid centralized handling of error codes and automating everything +To help with creating error codes, MeshKit contains a tool that analyzes, verifies and updates error codes in Meshery source code trees. It extracts error details into a file that can be used for publishing all error code references on the Meshery [error codes reference page]({{< ref "reference/error-codes.md" >}}). The objective to create this was to avoid centralized handling of error codes and automating everything In order to create a Meshery error object, you will need to create a custom wrapper object for the native golang error. This can be done from the MeshKit Error package. diff --git a/docs/content/en/project/contributing/contributing-models-quick-start.md b/docs/content/en/project/contributing/contributing-models-quick-start.md index 18b450d855ea8..dbb1602b09a3b 100644 --- a/docs/content/en/project/contributing/contributing-models-quick-start.md +++ b/docs/content/en/project/contributing/contributing-models-quick-start.md @@ -4,15 +4,15 @@ description: A no-fluff guide to creating your own Meshery Models quickly. categories: [contributing] --- -**Models follow Meshery's schema-driven development approach.** Model, Component, and Relationship definitions are validated against schemas in [`Model schema`](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/model). See [Contributing to Schemas](/project/contributing/contributing-schemas) for details. +**Models follow Meshery's schema-driven development approach.** Model, Component, and Relationship definitions are validated against schemas in [`Model schema`](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/model). See [Contributing to Schemas]({{< ref "project/contributing/contributing-schemas.md" >}}) for details. -[Meshery Models](/concepts/logical/models) are a way to represent the architecture of a system or application. Models are defined in JSON and can be used to visualize the components and relationships between them. This guide will walk you through the process of creating a new model. +[Meshery Models]({{< ref "concepts/logical/models/index.md" >}}) are a way to represent the architecture of a system or application. Models are defined in JSON and can be used to visualize the components and relationships between them. This guide will walk you through the process of creating a new model. -[Meshery Components](/concepts/logical/components) are the building blocks of a model. Each component represents a different part of the system or application. Components can be anything from a database to a microservice to a server. Relationships define how components interact with each other. For example, a database component might have a relationship with a microservice component that represents the microservice's dependency on the database. +[Meshery Components]({{< ref "concepts/logical/components.md" >}}) are the building blocks of a model. Each component represents a different part of the system or application. Components can be anything from a database to a microservice to a server. Relationships define how components interact with each other. For example, a database component might have a relationship with a microservice component that represents the microservice's dependency on the database. ### Creating your first Meshery Model -To get started quickly, check out the [Creating Models](/guides/configuration-management/creating-models) guide for step-by-step instructions. +To get started quickly, check out the [Creating Models]({{< ref "guides/configuration-management/creating-models/index.md" >}}) guide for step-by-step instructions. ### Contributing a Model Definition @@ -24,7 +24,7 @@ To get started quickly, check out the [Creating Models](/guides/configuration-ma ### Next Steps -To learn more about how to contribute and customize your models, check out the full [Contributing to Models](/project/contributing/contributing-models/) documentation. We encourage you to get involved in the development of Meshery Models and to share your feedback! +To learn more about how to contribute and customize your models, check out the full [Contributing to Models]({{< ref "project/contributing/contributing-models/index.md" >}}) documentation. We encourage you to get involved in the development of Meshery Models and to share your feedback! {{% alert color="info" title="Meshery Models are Extensible" %}} Meshery Models are designed to be extensible, allowing you to define new components as needed. If you have an idea for a new component, please create one and share it with the Meshery community. diff --git a/docs/content/en/project/contributing/images/meshmodel-architecture.svg b/docs/content/en/project/contributing/contributing-models/images/meshmodel-architecture.svg similarity index 100% rename from docs/content/en/project/contributing/images/meshmodel-architecture.svg rename to docs/content/en/project/contributing/contributing-models/images/meshmodel-architecture.svg diff --git a/docs/content/en/project/contributing/contributing-models.md b/docs/content/en/project/contributing/contributing-models/index.md similarity index 93% rename from docs/content/en/project/contributing/contributing-models.md rename to docs/content/en/project/contributing/contributing-models/index.md index 59ffae06c1897..e997f55381b6e 100644 --- a/docs/content/en/project/contributing/contributing-models.md +++ b/docs/content/en/project/contributing/contributing-models/index.md @@ -4,7 +4,7 @@ description: How to contribute to Meshery Models, Components, Relationships, Pol categories: [contributing] --- -**Meshery Models are schema-driven.** Model definitions, including their structure, metadata, and versioning, are defined by JSON Schemas in the [`meshery/schemas`](https://github.com/meshery/schemas) repository. Before contributing to models, familiarize yourself with the [Model schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/model) and see [Contributing to Schemas](/project/contributing/contributing-schemas) for the development workflow. +**Meshery Models are schema-driven.** Model definitions, including their structure, metadata, and versioning, are defined by JSON Schemas in the [`meshery/schemas`](https://github.com/meshery/schemas) repository. Before contributing to models, familiarize yourself with the [Model schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1beta1/model) and see [Contributing to Schemas]({{< ref "project/contributing/contributing-schemas.md" >}}) for the development workflow. ## Understanding the internals of Meshery's logical object model @@ -15,13 +15,13 @@ Meshery uses a logical object model to describe the infrastructure and capabilit At the core of this system are **Meshery Models** β€” packages that define a specific type of infrastructure, application, or capability. These models include: -- **[Components](/concepts/logical/components)**: Individual parts of a system (e.g., services, databases). -- **[Relationships](/concepts/logical/relationships)**: How those parts interact. +- **[Components]({{< ref "concepts/logical/components.md" >}})**: Individual parts of a system (e.g., services, databases). +- **[Relationships]({{< ref "concepts/logical/relationships/index.md" >}})**: How those parts interact. - **Metadata**: Visual and behavioral traits, such as icons or capabilities. Models can describe traditional technologies (like Kubernetes workloads), or more abstract entities (like annotations or diagrams). -> Learn more: [What are Meshery Models?](/concepts/logical/models) +> Learn more: [What are Meshery Models?]({{< ref "concepts/logical/models/index.md" >}}) #### What Is the Model Schema? @@ -29,9 +29,9 @@ Each model includes a set of entities (in the form of definitions) that Meshery The schema defines the structure of the model, including the entities it contains, their relationships, and the properties they have. The schema also defines the version of the model and the version of the schema itself. -> See [Registry](/concepts/logical/registry) to learn more about Meshery's internal registry and how to use it. +> See [Registry]({{< ref "concepts/logical/registry.md" >}}) to learn more about Meshery's internal registry and how to use it. -[![Model Entity Classification](/project/contributing/images/meshmodel-architecture.svg)](/project/contributing/images/meshery-models.png) +[![Model Entity Classification](images/meshmodel-architecture.svg)](../images/meshery-models.png) _Figure: Model Entity Classification_ ## Meshery Entities and their Lifecycle @@ -174,7 +174,7 @@ To simplify the assignment of these capabilities, Meshery organizes these capabi ### Importing and Creating Models Models can be created from scratch or imported using either the Meshery UI or the Meshery CLI. -To learn more, see the detailed guides on [Importing Models](/guides/configuration-management/importing-models) and [Creating Models](/guides/configuration-management/creating-models). +To learn more, see the detailed guides on [Importing Models]({{< ref "guides/configuration-management/importing-models/index.md" >}}) and [Creating Models]({{< ref "guides/configuration-management/creating-models/index.md" >}}). > Use **Create** if you're starting from scratch. Use **Import** if you already have model definitions (e.g., JSON, CSV, tar). @@ -203,7 +203,7 @@ When Meshery processes schemas: 1. **Parsing**: The source is parsed to extract schema specifications for every entity. 2. **Component Creation**: A component definition is generated for each entity, capturing its kind, version, and schema. 3. **Model Assignment**: Components are automatically assigned to a Model based on their source context. -4. **Registration**: Components are registered in Meshery's [Registry](/concepts/logical/registry) under their respective model. +4. **Registration**: Components are registered in Meshery's [Registry]({{< ref "concepts/logical/registry.md" >}}) under their respective model. 5. **Enrichment**: Components inherit default properties from their model and can be further customized. This automatic grouping allows you to manage related resources as cohesive units within Meshery designs. @@ -292,12 +292,12 @@ During model generation, corresponding components are created. Next step is to e - Review and confirm assigned capabilities - Modify capabilities as needed - See the [Contributing to Components](/project/contributing/contributing-components) for detailed instructions. + See the [Contributing to Components]({{< ref "project/contributing/contributing-components.md" >}}) for detailed instructions. 2. **Identify Relationships** - **2.1. Review Available Types** - Review and familiarize yourself with the predefined relationship kinds, types, and subtypes. See ["Relationships logical concepts"](/concepts/logical/relationships) + Review and familiarize yourself with the predefined relationship kinds, types, and subtypes. See ["Relationships logical concepts"]({{< ref "concepts/logical/relationships/index.md" >}}) - **2.2. Map Component Relationships** @@ -308,7 +308,7 @@ During model generation, corresponding components are created. Next step is to e - **2.3. Create Definitions** Codify the relationships you have identified into a Relationship Definition - See the [Contributing to Relationships](/project/contributing/contributing-relationships) for detailed instructions. + See the [Contributing to Relationships]({{< ref "project/contributing/contributing-relationships.md" >}}) for detailed instructions. ## Next Steps diff --git a/docs/content/en/project/contributing/contributing-relationships.md b/docs/content/en/project/contributing/contributing-relationships.md index 046d8b823380c..a48c653e12448 100644 --- a/docs/content/en/project/contributing/contributing-relationships.md +++ b/docs/content/en/project/contributing/contributing-relationships.md @@ -4,9 +4,9 @@ description: How to contribute to Meshery Models Relationships, Policies... categories: [contributing] --- -**Relationships follow a schema-defined structure.** The [Relationship schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1alpha3/relationship) specifies how relationships between components are expressed. Refer to the schema when defining new relationship types or selectors. See [Contributing to Schemas](/project/contributing/contributing-schemas) for details. +**Relationships follow a schema-defined structure.** The [Relationship schema](https://github.com/meshery/schemas/tree/master/schemas/constructs/v1alpha3/relationship) specifies how relationships between components are expressed. Refer to the schema when defining new relationship types or selectors. See [Contributing to Schemas]({{< ref "project/contributing/contributing-schemas.md" >}}) for details. -[Relationships](/concepts/logical/relationships) within [Models](/concepts/logical/models) play a crucial role in establishing concrete visualisations of efficient data flow between different components of Meshery. These are used to classify the nature of interaction between one or more interconnected [Components](/concepts/logical/components). +[Relationships]({{< ref "concepts/logical/relationships/index.md" >}}) within [Models]({{< ref "concepts/logical/models/index.md" >}}) play a crucial role in establishing concrete visualisations of efficient data flow between different components of Meshery. These are used to classify the nature of interaction between one or more interconnected [Components]({{< ref "concepts/logical/components.md" >}}). ## Overview of Steps to Create Relationships @@ -140,7 +140,7 @@ Once selected, note the relationship's `kind`, `type`, and `subtype` of your sel ### 3. Create a Relationship Definition as a JSON file -Create a relationship definition as a JSON file, placing this new definition file into its respective model folder (see [Contributing to Models](/project/contributing/contributing-models)). Relationship definition files are commonly named `relationships.yaml` as a convention, however, this name is not required. A model may include any number of relationship definitions. Include the following attributes in your relationship definition: +Create a relationship definition as a JSON file, placing this new definition file into its respective model folder (see [Contributing to Models]({{< ref "project/contributing/contributing-models/index.md" >}})). Relationship definition files are commonly named `relationships.yaml` as a convention, however, this name is not required. A model may include any number of relationship definitions. Include the following attributes in your relationship definition: - `kind`: The genre of relationship (e.g., hierarchical, edge, sibling). - `type`: The augmentative category of the relationship (e.g., binding, non-binding, inventory). @@ -362,7 +362,7 @@ Submit a pull request to the Meshery repository with your new relationship defin Keeping your relationship definition in a separate file allows for easier management and review of the relationship(s) you have defined. {{% alert title="Keeping your custom Relationships private" color="info" %}} -Alternatively, if you would like to keep the relatioship definition private, you can bundle your relatinship(s) in a custom model, import the custom model into your Meshery deployment. Your private relationship definition(s) will be registered in your Meshery Server's registry and available for use within your Meshery deployment. +Alternatively, if you would like to keep the relatioship definition private, you can bundle your relatinship(s) in a custom model, import the custom model into your Meshery deployment. Your private relationship definition(s) will be registered in your Meshery Server's registry and available for use within your Meshery deployment. {{% /alert %}} For more information refer - [Model - Construct Models in Meshery](https://docs.google.com/document/d/16z5hA8qVfSq885of9LXFUVvfom-hQXr-6oTD_GgoFmk/edit) diff --git a/docs/content/en/project/contributing/contributing-schemas.md b/docs/content/en/project/contributing/contributing-schemas.md index c664cd8853388..e45ae6e6d67ec 100644 --- a/docs/content/en/project/contributing/contributing-schemas.md +++ b/docs/content/en/project/contributing/contributing-schemas.md @@ -635,7 +635,7 @@ metadata: The extensions above are all consumed by Meshery's internal build pipeline. `x-annotations` is different β€” it is the designated extension point for **remote providers** to attach provider-specific metadata to Meshery schemas at runtime. Meshery core does not read, validate, or act on `x-annotations`; only your provider-side code does. -For full documentation including usage boundaries and a concrete example, see [Extensibility: Schemas](/reference/extensibility/schemas/). +For full documentation including usage boundaries and a concrete example, see [Extensibility: Schemas]({{< ref "reference/extensibility/schemas.md" >}}). --- diff --git a/docs/content/en/project/contributing/images/events-table.png b/docs/content/en/project/contributing/contributing-server-events/images/events-table.png similarity index 100% rename from docs/content/en/project/contributing/images/events-table.png rename to docs/content/en/project/contributing/contributing-server-events/images/events-table.png diff --git a/docs/content/en/project/contributing/contributing-server-events.md b/docs/content/en/project/contributing/contributing-server-events/index.md similarity index 98% rename from docs/content/en/project/contributing/contributing-server-events.md rename to docs/content/en/project/contributing/contributing-server-events/index.md index 89be17f208efd..0c00cf9472f75 100644 --- a/docs/content/en/project/contributing/contributing-server-events.md +++ b/docs/content/en/project/contributing/contributing-server-events/index.md @@ -50,13 +50,13 @@ _Note: In certain conditions you must add some fields with specific keys:_ - `WithMetadata`: it takes a Map `map[string]interface{}` data structure containing any supplementary information that the developer/contributor deems essential for the user to be informed about. - `Build` : returns the [Event](https://github.com/meshery/meshkit/blob/ea3c60907a1cd1902902a4113206579992772083/models/events/events.go#L37) instance constructed upon the previously described functions and prepares it for publication through the [Broadcast](https://github.com/meshery/meshery/blob/1b5d78ed34648e0a91df8c2273026b930f748fbc/server/models/event_broadcast.go#L14), which is responsible for disseminating events. - - Event Schema + + Event Schema ## Event Persistence in Meshery -Events in Meshery are persisted through two distinct mechanisms to ensure reliable event management. [Read more about providers](/extensibility/providers). +Events in Meshery are persisted through two distinct mechanisms to ensure reliable event management. [Read more about providers]({{< ref "reference/extensibility/providers/index.md" >}}). ### Local Event Storage diff --git a/docs/content/en/project/contributing/contributing-server.md b/docs/content/en/project/contributing/contributing-server.md index 055f43eb64005..f8502ff2b76ea 100644 --- a/docs/content/en/project/contributing/contributing-server.md +++ b/docs/content/en/project/contributing/contributing-server.md @@ -27,8 +27,8 @@ After running Meshery server, you will need to select your **Cloud Provider** by **Please note**: If you get error while starting the server as **"Meshery Development Incompatible"** then follow the below guideline πŸ‘‡ - - + + Potential Solution: @@ -53,7 +53,7 @@ Every Golang-based component within the Meshery ecosystem incorporates a utility {{< code code=`make error` >}} -For more details, Error Utility +For more details, }}">Error Utility ### Configuring Log levels at Runtime diff --git a/docs/content/en/project/contributing/images/dry-run-formatter.png b/docs/content/en/project/contributing/contributing-ui-notification-center/images/dry-run-formatter.png similarity index 100% rename from docs/content/en/project/contributing/images/dry-run-formatter.png rename to docs/content/en/project/contributing/contributing-ui-notification-center/images/dry-run-formatter.png diff --git a/docs/content/en/project/contributing/images/error-formatter.png b/docs/content/en/project/contributing/contributing-ui-notification-center/images/error-formatter.png similarity index 100% rename from docs/content/en/project/contributing/images/error-formatter.png rename to docs/content/en/project/contributing/contributing-ui-notification-center/images/error-formatter.png diff --git a/docs/content/en/project/contributing/images/model-register-formatter.png b/docs/content/en/project/contributing/contributing-ui-notification-center/images/model-register-formatter.png similarity index 100% rename from docs/content/en/project/contributing/images/model-register-formatter.png rename to docs/content/en/project/contributing/contributing-ui-notification-center/images/model-register-formatter.png diff --git a/docs/content/en/project/contributing/images/relationship-evaluation-formatter.png b/docs/content/en/project/contributing/contributing-ui-notification-center/images/relationship-evaluation-formatter.png similarity index 100% rename from docs/content/en/project/contributing/images/relationship-evaluation-formatter.png rename to docs/content/en/project/contributing/contributing-ui-notification-center/images/relationship-evaluation-formatter.png diff --git a/docs/content/en/project/contributing/contributing-ui-notification-center.md b/docs/content/en/project/contributing/contributing-ui-notification-center/index.md similarity index 95% rename from docs/content/en/project/contributing/contributing-ui-notification-center.md rename to docs/content/en/project/contributing/contributing-ui-notification-center/index.md index 5822a425631ee..00c368733af0e 100644 --- a/docs/content/en/project/contributing/contributing-ui-notification-center.md +++ b/docs/content/en/project/contributing/contributing-ui-notification-center/index.md @@ -5,7 +5,7 @@ categories: [contributing] ---

      Prerequisite Reading

      -
      1. Contributing to Meshery UI
      +
      1. }}">Contributing to Meshery UI
      ## Table of Contents @@ -190,7 +190,7 @@ The `ErrorMetadataFormatter` is used for formatting error-related notifications /> ``` -Error Formatter +Error Formatter **When to Use:** @@ -217,7 +217,7 @@ The `Model Registration Formatter` formats and displays model registration detai - `modelDetails` (object) – Contains model import data. -Model Register Formatter +Model Register Formatter ### Relationship Evaluation Formatter @@ -242,7 +242,7 @@ The **Relationship Evaluation Formatter** is responsible for rendering notificat - `relationshipsUpdated` (Array) - `relationshipsRemoved` (Array) -Relationship Evaluation Formatter +Relationship Evaluation Formatter #### When to Use @@ -307,7 +307,7 @@ The **Dry Run Formatter** is responsible for rendering notifications related to - **validationMachine** (object): The state machine handling the dry run validation process. - **currentComponentName** (string): The name of the component currently being validated. -Dry Run Formatter +Dry Run Formatter #### When to Use diff --git a/docs/content/en/project/contributing/images/sistent-modal.png b/docs/content/en/project/contributing/contributing-ui-sistent/images/sistent-modal.png similarity index 100% rename from docs/content/en/project/contributing/images/sistent-modal.png rename to docs/content/en/project/contributing/contributing-ui-sistent/images/sistent-modal.png diff --git a/docs/content/en/project/contributing/contributing-ui-sistent.md b/docs/content/en/project/contributing/contributing-ui-sistent/index.md similarity index 94% rename from docs/content/en/project/contributing/contributing-ui-sistent.md rename to docs/content/en/project/contributing/contributing-ui-sistent/index.md index 85c9770fcbbc3..860375493499e 100644 --- a/docs/content/en/project/contributing/contributing-ui-sistent.md +++ b/docs/content/en/project/contributing/contributing-ui-sistent/index.md @@ -5,7 +5,7 @@ categories: [contributing] ---

      Prerequisite Reading

      -
      1. Contributing to Meshery UI
      +
      1. }}">Contributing to Meshery UI
      ## Contributing to Meshery UI - Sistent @@ -18,8 +18,8 @@ Sistent leverages Material UI libraries and provides a custom theme on top of it - This `Modal` is a Sistent Standard Modal used in validation of design. - - + + ### How to use Sistent in Meshery UI diff --git a/docs/content/en/project/contributing/contributing-ui-tests.md b/docs/content/en/project/contributing/contributing-ui-tests.md index 1c038bb50b4d8..899c54896d0a9 100644 --- a/docs/content/en/project/contributing/contributing-ui-tests.md +++ b/docs/content/en/project/contributing/contributing-ui-tests.md @@ -37,8 +37,8 @@ There are a few ways to set up the Meshery UI and server, but for end-to-end tes {{% alert color="warning" title="Several Test may break" %}} Some test cases required you to have kubernetes cluster and build meshery adapter as well, be aware of that. Which is out of scope for this documentation - + {{% /alert %}} ### Native OS Build (Recommended) @@ -190,4 +190,4 @@ To filter and view only UI-related tests using the Sheet Views feature: 1. In the top menu bar, click Data β†’ Change view 2. Choose the pre-defined view labeled "UI" -![Meshery Test Plan Screenshot](/project/contributing/images/meshery-test-plan-v0.8.0-ui.png) +![Meshery Test Plan Screenshot](../images/meshery-test-plan-v0.8.0-ui.png) diff --git a/docs/content/en/project/contributing/images/dashboard-widgets.png b/docs/content/en/project/contributing/contributing-ui-widgets/images/dashboard-widgets.png similarity index 100% rename from docs/content/en/project/contributing/images/dashboard-widgets.png rename to docs/content/en/project/contributing/contributing-ui-widgets/images/dashboard-widgets.png diff --git a/docs/content/en/project/contributing/contributing-ui-widgets.md b/docs/content/en/project/contributing/contributing-ui-widgets/index.md similarity index 96% rename from docs/content/en/project/contributing/contributing-ui-widgets.md rename to docs/content/en/project/contributing/contributing-ui-widgets/index.md index 9b882b732fdf7..26223b1860a92 100644 --- a/docs/content/en/project/contributing/contributing-ui-widgets.md +++ b/docs/content/en/project/contributing/contributing-ui-widgets/index.md @@ -5,7 +5,7 @@ categories: [contributing] ---

      Prerequisite Reading

      -
      1. Contributing to Meshery UI
      +
      1. }}">Contributing to Meshery UI
      Meshery's dashboard is a composable and extensible interface made up of individual widgets. These widgets allow contributors to surface specific Meshery data or capabilities within a modular layout system. @@ -157,8 +157,8 @@ Meshery stores user layout preferences either in local storage or via the provid This is how your default widget would appear in the dashboard: - - + + --- diff --git a/docs/content/en/project/contributing/contributing-ui.md b/docs/content/en/project/contributing/contributing-ui.md index 3c93f3edaae38..9cd749fe07d5e 100644 --- a/docs/content/en/project/contributing/contributing-ui.md +++ b/docs/content/en/project/contributing/contributing-ui.md @@ -26,19 +26,19 @@ Meshery UI and Provider UI use [Next.js](https://nextjs.org/) with [SWC](https:/ Meshery UI uses a schema-driven approach where components and forms are generated from JSON schemas. This enables dynamic UI adaptation, consistent validation, and type-safety across the application. -**⚠️ Required Reading:** Before contributing, you must read the [Schema-Driven UI Development Guide](/project/contributing/contributing-ui-schemas) to understand how Meshery's UI components are generated and maintained using schemas. +**⚠️ Required Reading:** Before contributing, you must read the [Schema-Driven UI Development Guide]({{< ref "project/contributing/contributing-ui-schemas.md" >}}) to understand how Meshery's UI components are generated and maintained using schemas. ## Meshery Server APIs -The [API overview](/extensibility/api) in the Extensibility guide offers high-level insight, while each API reference (below) offers details pertaining to each API endpoints' behavior and use. +The [API overview]({{< ref "reference/extensibility/api.md" >}}) in the Extensibility guide offers high-level insight, while each API reference (below) offers details pertaining to each API endpoints' behavior and use. ### REST API -Meshery provides a REST API available through the default port of `9081/tcp` at `:/api/`. See the [REST API Reference](/reference/rest-apis) for a complete list of endpoints available with short description of their purpose and example code. +Meshery provides a REST API available through the default port of `9081/tcp` at `:/api/`. See the [REST API Reference]({{< ref "reference/rest-apis/_index.md" >}}) for a complete list of endpoints available with short description of their purpose and example code. ### GraphQL API -Meshery provides a GraphQl API available through the default port of `9081/tcp` at `:/api/graphql/query`. See the [GraphQL API Reference](/reference/graphql-apis) [Relay](https://relay.dev) is the client used. +Meshery provides a GraphQl API available through the default port of `9081/tcp` at `:/api/graphql/query`. See the [GraphQL API Reference]({{< ref "reference/graphql-apis.md" >}}) [Relay](https://relay.dev) is the client used. ## Design @@ -61,7 +61,7 @@ The designs in this specification should result in enabling: ## Setup {{% alert color="info" title="Windows User?" %}} -See Setting up Meshery Development Environment on Windows. +See Setting up Meshery Development Environment on Windows. {{% /alert %}} ### Required Node Version @@ -104,8 +104,8 @@ Now, Meshery will run on the default port `http://localhost:9081`. **Please note**: If you see "Meshery Development Incompatible" while trying to sign into Meshery Server, then follow these steps: - - + + Potential Solution: @@ -124,7 +124,7 @@ If you want to work on the UI, it will be a good idea to use the included UI dev {{< code code=`make ui` >}} -Refer to [Contributing to Meshery Server](contributing-server), if needed. +Refer to [Contributing to Meshery Server]({{< ref "project/contributing/contributing-server.md" >}}), if needed. > Make sure to have Meshery Server configured, up and running on the default port `http://localhost:9081` and choose a provider to login with (visit `http://localhost:9081`) before proceeding to access and work on the UI server at `http://localhost:3000`. @@ -132,7 +132,7 @@ Any UI changes made now will _automatically_ be rebuilt and served in your brows ### Running end-to-end integration tests -Refer to [Meshery UI Testing](contributing-ui-tests) for details of how to contribute and benefit from Meshery UI testing. +Refer to [Meshery UI Testing]({{< ref "project/contributing/contributing-ui-tests.md" >}}) for details of how to contribute and benefit from Meshery UI testing. ### Static Files, Icons and Images diff --git a/docs/content/en/project/contributing/images/win-environment-variables.png b/docs/content/en/project/contributing/meshery-windows/images/win-environment-variables.png similarity index 100% rename from docs/content/en/project/contributing/images/win-environment-variables.png rename to docs/content/en/project/contributing/meshery-windows/images/win-environment-variables.png diff --git a/docs/content/en/project/contributing/meshery-windows.md b/docs/content/en/project/contributing/meshery-windows/index.md similarity index 97% rename from docs/content/en/project/contributing/meshery-windows.md rename to docs/content/en/project/contributing/meshery-windows/index.md index 5dbcd61250140..c4e6a7e2c608f 100644 --- a/docs/content/en/project/contributing/meshery-windows.md +++ b/docs/content/en/project/contributing/meshery-windows/index.md @@ -169,11 +169,11 @@ Launch Git Bash, PowerShell or VS Code Terminal and run the following commands t If any of these result in command not found error, check if the PATH in environment variables has been set properly. To launch the environment variables window Here's an example: - - + + -You are now ready to [contribute](/project/contributing/) to Meshery. +You are now ready to [contribute]({{< ref "project/contributing/_index.md" >}}) to Meshery. ## Using Hyper-V to install a linux VM diff --git a/docs/content/en/project/overview.md b/docs/content/en/project/overview.md index 7941dc3f292e4..7a5daab14a92d 100644 --- a/docs/content/en/project/overview.md +++ b/docs/content/en/project/overview.md @@ -55,7 +55,7 @@ Using Meshery extensions you can freely collaborate across projects and team wit **Design patterns and Meshery Catalog** -Through [Models](/concepts/logical/models), Meshery describes infrastructure under management, enabling you to define cloud native designs and patterns and then to export those designs and share within the Meshery Catalog. +Through [Models]({{< ref "concepts/logical/models/index.md" >}}), Meshery describes infrastructure under management, enabling you to define cloud native designs and patterns and then to export those designs and share within the Meshery Catalog. @@ -32,7 +32,7 @@ GraphQL API | fa fa-globe

      Explore the Meshery GraphQL API using the interactive Playground provided with Meshery instance at http://localhost:9081/api/system/graphql/playground.

      {{% alert color="dark" title="Meshery's GraphQL API Reference" %}} -See [GraphQL API Reference](/reference/graphql-apis) Self-generated API documentation for Meshery's GraphQL API. The API can be explored interactively using the GraphQL Playground. Documentation is generated from Meshery's GraphQL schema. Each table below documents a GraphQL type. +See [GraphQL API Reference]({{< ref "reference/graphql-apis.md" >}}) Self-generated API documentation for Meshery's GraphQL API. The API can be explored interactively using the GraphQL Playground. Documentation is generated from Meshery's GraphQL schema. Each table below documents a GraphQL type. {{% /alert %}} {{< /tabs >}} @@ -41,7 +41,7 @@ See [GraphQL API Reference](/reference/graphql-apis) Self-generated API document Requests to any of the API endpoints must be authenticated and include a valid JWT access token in the HTTP headers. Type of authentication is determined by the selected [Provider](#providers). Use of the Local Provider, "None", puts Meshery into single-user mode and does not require authentication. {{% alert color="dark" title="What are authentication tokens?" %}} -Meshery authentication tokens allow users or systems to authenticate with Meshery Server via either its two clients, [Meshery CLI](/reference/mesheryctl) and [UI](/extensibility/api#how-to-get-your-token), or its two APIs: [REST](/reference/rest-apis) or [GraphQL](/reference/graphql-apis). +Meshery authentication tokens allow users or systems to authenticate with Meshery Server via either its two clients, [Meshery CLI]({{< ref "reference/mesheryctl/_index.md" >}}) and [UI](#how-to-get-your-token), or its two APIs: [REST]({{< ref "reference/rest-apis/_index.md" >}}) or [GraphQL]({{< ref "reference/graphql-apis.md" >}}). Meshery's authentication token system provide secure access to Meshery's powerful management features. {{% /alert %}} @@ -79,7 +79,7 @@ The request will be sent to the Meshery API using the configured cookies for aut Each of the API endpoints are exposed through [server.go](https://github.com/meshery/meshery/blob/master/server/router/server.go). Endpoints are grouped by function (e.g. `/api/mesh` or `/api/perf`). -Alternatively, [Remote Providers](./providers) can extend Meshery's endpoints behind the `/api/extensions/` endpoint. +Alternatively, [Remote Providers]({{< ref "reference/extensibility/providers/index.md" >}}) can extend Meshery's endpoints behind the `/api/extensions/` endpoint. ## Authorization diff --git a/docs/content/en/reference/extensibility/authorization/index.md b/docs/content/en/reference/extensibility/authorization/index.md index 73a1ba58a5e92..5bd61b5f9edbb 100644 --- a/docs/content/en/reference/extensibility/authorization/index.md +++ b/docs/content/en/reference/extensibility/authorization/index.md @@ -5,14 +5,14 @@ aliases: - /extensibility/authorization --- -Meshery features an extensible authorization system that offers the ability to deliver fine-grained access control across it's web-based user interface, [Meshery UI](/concepts/architecture). +Meshery features an extensible authorization system that offers the ability to deliver fine-grained access control across it's web-based user interface, [Meshery UI]({{< ref "concepts/architecture/_index.md" >}}). ## Authorization Keys -The extensible authorization system consists of a large set of keys. Each key uniquely represents a specific capability, for example, the ability to view a [Connection](/concepts/logical/connections), edit or delete a Connection. With the help of these keys, the system evaluates the permissions during runtime and renders UI both helping offer a secure management system and a customizable user experience. +The extensible authorization system consists of a large set of keys. Each key uniquely represents a specific capability, for example, the ability to view a [Connection]({{< ref "concepts/logical/connections/index.md" >}}), edit or delete a Connection. With the help of these keys, the system evaluates the permissions during runtime and renders UI both helping offer a secure management system and a customizable user experience. {{% alert color="info" title="Note" %}} -The extensible authorization system is available to both Local and Remote Providers. Depending upon your chosen [Remote Provider](/extensibility/providers), keys, clustering of them, assigning them to user groups, not just individual users or to user roles may be offered. +The extensible authorization system is available to both Local and Remote Providers. Depending upon your chosen [Remote Provider]({{< ref "reference/extensibility/providers/index.md" >}}), keys, clustering of them, assigning them to user groups, not just individual users or to user roles may be offered. {{% /alert %}} ## Authorization Framework @@ -42,7 +42,7 @@ It's important to understand not all pages uses CASL authorization, means even i ## Authorization using Local Provider -Meshery's built-in identity provider, "Local" Provider, operates with a large set of predefined keys interspersed throughout Meshery UI and persisted in [Meshery Database](/concepts/architecture/database). These keys are used to evaluate the permissions of a given user and render the UI accordingly. The keys are grouped into three categories: `action`, `subject`, and `object`. +Meshery's built-in identity provider, "Local" Provider, operates with a large set of predefined keys interspersed throughout Meshery UI and persisted in [Meshery Database]({{< ref "concepts/architecture/database/index.md" >}}). These keys are used to evaluate the permissions of a given user and render the UI accordingly. The keys are grouped into three categories: `action`, `subject`, and `object`. {{< discuss >}} diff --git a/docs/content/en/reference/extensibility/build-time/index.md b/docs/content/en/reference/extensibility/build-time.md similarity index 91% rename from docs/content/en/reference/extensibility/build-time/index.md rename to docs/content/en/reference/extensibility/build-time.md index f4e64ed80b98b..8b15375954932 100644 --- a/docs/content/en/reference/extensibility/build-time/index.md +++ b/docs/content/en/reference/extensibility/build-time.md @@ -115,13 +115,13 @@ When using build-time extensions: ### Comparison with Runtime Extension Points -Meshery supports multiple [extension points](/extensibility) at different stages: +Meshery supports multiple [extension points]({{< ref "reference/extensibility/_index.md" >}}) at different stages: | Extension Point | When | Use Case | |----------------|------|----------| -| **[Build-time](/extensibility/build-time)** | During `docker build` | Pre-package custom configurations, offline packages, proprietary plugins | -| **[Boot-time](/extensibility)** | Container startup | Dynamic configuration that can change between deployments | -| **[Runtime](/extensibility)** | While Meshery is running | User-installed plugins, dynamically loaded extensions | +| **[Build-time]({{< ref "reference/extensibility/build-time.md" >}})** | During `docker build` | Pre-package custom configurations, offline packages, proprietary plugins | +| **[Boot-time]({{< ref "reference/extensibility/_index.md" >}})** | Container startup | Dynamic configuration that can change between deployments | +| **[Runtime]({{< ref "reference/extensibility/_index.md" >}})** | While Meshery is running | User-installed plugins, dynamically loaded extensions | Choose the build-time extension point when you need to: - Bundle organization-specific customizations in a custom container image diff --git a/docs/content/en/reference/extensibility/load-generators/index.md b/docs/content/en/reference/extensibility/load-generators.md similarity index 100% rename from docs/content/en/reference/extensibility/load-generators/index.md rename to docs/content/en/reference/extensibility/load-generators.md diff --git a/docs/content/en/reference/extensibility/providers/index.md b/docs/content/en/reference/extensibility/providers/index.md index c78883a98c6cf..075cf517bc0fd 100644 --- a/docs/content/en/reference/extensibility/providers/index.md +++ b/docs/content/en/reference/extensibility/providers/index.md @@ -78,7 +78,7 @@ Name: **"Meshery"** (default), URL: `https://cloud.meshery.io` - Long-term term persistence. - Save environment setup. - Retrieve performance test results. -- Events are stored locally and can be published to remote provider. [Read more about server events](/project/contributing/contributing-server-events) +- Events are stored locally and can be published to remote provider. [Read more about server events]({{< ref "project/contributing/contributing-server-events/index.md" >}}) Name: **"Digital Ocean"**, URL: `https://meshery.digitalocean.com` @@ -93,7 +93,7 @@ Name: **"Acme"** - Long-term term persistence. - Save environment setup. - Retrieve performance test results. -- Events are stored locally and can be published to remote provider. [Read more about server events](/project/contributing/contributing-server-events) +- Events are stored locally and can be published to remote provider. [Read more about server events]({{< ref "project/contributing/contributing-server-events/index.md" >}}) - Free to use. ### Local Provider @@ -107,7 +107,7 @@ Name: **"Local"** (legacy alias: **"None"**) - Container-local storage of test results. Ephemeral. - Environment setup not saved. - No performance test result history. -- Server events are stored locally in database. [Read more about server events](/project/contributing/contributing-server-events) +- Server events are stored locally in database. [Read more about server events]({{< ref "project/contributing/contributing-server-events/index.md" >}}) - Free to use. #### Login Behavior @@ -228,7 +228,7 @@ Meshery keeps the implementation of Remote Providers separate so that they are b ### Verifying Compatibility With Golang Version Update -When Meshery is updated to a newer version of Golang, extension providers need to ensure their integrations remain compatible with the updated version. Changes in the Golang version can lead to compatibility issues, so it’s important to update your extension to align with Meshery’s new environment. For a detailed guide on how to verify and address any compatibility issues, refer to this [guide on verifying compatibility](./verify-compatibility). +When Meshery is updated to a newer version of Golang, extension providers need to ensure their integrations remain compatible with the updated version. Changes in the Golang version can lead to compatibility issues, so it’s important to update your extension to align with Meshery’s new environment. For a detailed guide on how to verify and address any compatibility issues, refer to this [guide on verifying compatibility]({{< ref "reference/extensibility/verify-compatibility.md" >}}). ### Remote Provider Extension Points diff --git a/docs/content/en/reference/extensibility/schemas/index.md b/docs/content/en/reference/extensibility/schemas.md similarity index 77% rename from docs/content/en/reference/extensibility/schemas/index.md rename to docs/content/en/reference/extensibility/schemas.md index 413a260ba88f9..e37031fbdb1cb 100644 --- a/docs/content/en/reference/extensibility/schemas/index.md +++ b/docs/content/en/reference/extensibility/schemas.md @@ -5,7 +5,7 @@ aliases: - /extensibility/schemas --- -Meshery follows a [Schema-Driven Development](/project/contributing/contributing-schemas/) approach in which schemas define the structure of data across the platform. To support remote providers, Meshery schemas are intentionally extensible via `x-*` vendor extensions β€” a standard OpenAPI mechanism that allows custom metadata to be attached to a schema without affecting tools or validators that don't recognize it. +Meshery follows a [Schema-Driven Development]({{< ref "project/contributing/contributing-schemas.md" >}}) approach in which schemas define the structure of data across the platform. To support remote providers, Meshery schemas are intentionally extensible via `x-*` vendor extensions β€” a standard OpenAPI mechanism that allows custom metadata to be attached to a schema without affecting tools or validators that don't recognize it. ## x-annotations as an Extension Point @@ -53,7 +53,7 @@ if annotations, ok := schema["x-annotations"].(map[string]interface{}); ok { ## Related -- [Extensibility: Providers](/reference/extensibility/providers/) -- [Contributing to Meshery Schemas](/project/contributing/contributing-schemas/) +- [Extensibility: Providers]({{< ref "reference/extensibility/providers/index.md" >}}) +- [Contributing to Meshery Schemas]({{< ref "project/contributing/contributing-schemas.md" >}}) {{< discuss >}} diff --git a/docs/content/en/reference/extensibility/ui/index.md b/docs/content/en/reference/extensibility/ui.md similarity index 94% rename from docs/content/en/reference/extensibility/ui/index.md rename to docs/content/en/reference/extensibility/ui.md index 4def54f846484..803adefd18444 100644 --- a/docs/content/en/reference/extensibility/ui/index.md +++ b/docs/content/en/reference/extensibility/ui.md @@ -25,7 +25,7 @@ See this [RJSF Component](https://github.com/meshery/meshery/blob/0bc68d1cd0ba80 ### Extensibility: User Accounts -Meshery Server uses [Providers](/extensibility/providers) for identity management. Providers can implement the `user_account` extension to handle custom user management scenarios. The user avatar behavior, which changes based on the user's status, can be customized by extending the [User Component](https://github.com/meshery/meshery/blob/7de49ef4928f114080f923f2ad261f4433ca91d6/ui/components/User.js#L46). +Meshery Server uses [Providers]({{< ref "reference/extensibility/providers/index.md" >}}) for identity management. Providers can implement the `user_account` extension to handle custom user management scenarios. The user avatar behavior, which changes based on the user's status, can be customized by extending the [User Component](https://github.com/meshery/meshery/blob/7de49ef4928f114080f923f2ad261f4433ca91d6/ui/components/User.js#L46). ### Build-Time UI Extensibility diff --git a/docs/content/en/reference/extensibility/verify-compatibility/index.md b/docs/content/en/reference/extensibility/verify-compatibility.md similarity index 95% rename from docs/content/en/reference/extensibility/verify-compatibility/index.md rename to docs/content/en/reference/extensibility/verify-compatibility.md index 49f239e09865b..4b62c71a71881 100644 --- a/docs/content/en/reference/extensibility/verify-compatibility/index.md +++ b/docs/content/en/reference/extensibility/verify-compatibility.md @@ -10,7 +10,7 @@ The Meshery ecosystem is designed for extensibility, with the core platform (`me This guide outlines the key areas of compatibility and provides a general process for extension developers to follow when Meshery's underlying frameworks are updated. {{% alert color="info" title="Meshery's Bill of Materials" %}} -Meshery's version is defined by its [Bill of Materials (BOM)](/project/contributing#meshery-contribution-flow), which specifies versions for Go, Node.js, and other key dependencies. Extension developers should reference the BOM to ensure alignment. +Meshery's version is defined by its [Bill of Materials (BOM)]({{< ref "project/contributing/_index.md#meshery-contribution-flow" >}}), which specifies versions for Go, Node.js, and other key dependencies. Extension developers should reference the BOM to ensure alignment. {{% /alert %}} ## Key Areas for Compatibility diff --git a/docs/content/en/reference/meshery-operator-crds.md b/docs/content/en/reference/meshery-operator-crds.md index dc41c18ca525b..a4fe5b0d4d922 100644 --- a/docs/content/en/reference/meshery-operator-crds.md +++ b/docs/content/en/reference/meshery-operator-crds.md @@ -3,11 +3,11 @@ title: Meshery Operator CRD Reference description: Details for the Custom Resource Definitions included in Meshery Operator and used by it's custom controllers. --- -Included in [Meshery Operator](/concepts/architecture/operator) are a couple of Kubernetes Custom Resource Definitions (CRDs) and a ConfigMap. +Included in [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) are a couple of Kubernetes Custom Resource Definitions (CRDs) and a ConfigMap. ## Broker CRD -The CRD is used to configure [Broker](/concepts/architecture/broker) instances in a cluster. +The CRD is used to configure [Broker]({{< ref "concepts/architecture/broker/index.md" >}}) instances in a cluster. ## YAML synopsis @@ -71,7 +71,7 @@ spec: ``` ## MeshSync CRD -The MeshSync CRD is used as a configuration tool the [MeshSync](/concepts/architecture/meshsync). The CRD is used to control the replica count for MeshSync instances, [Broker](/concepts/architecture/broker) configuration and the resources that MeshSync watches and listens to in a cluster. +The MeshSync CRD is used as a configuration tool the [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}). The CRD is used to control the replica count for MeshSync instances, [Broker]({{< ref "concepts/architecture/broker/index.md" >}}) configuration and the resources that MeshSync watches and listens to in a cluster. ### YAML Synopsis @@ -161,7 +161,7 @@ The following section outlines the fields and their descriptions The following section defines the usage for this Custom Resource -The Custom Resource is used to configure the [Broker](/concepts/architecture/broker) and Events to be tracked by [MeshSync](/concepts/architecture/meshsync) +The Custom Resource is used to configure the [Broker]({{< ref "concepts/architecture/broker/index.md" >}}) and Events to be tracked by [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) #### Example Use diff --git a/docs/content/en/reference/mesheryctl/_index.md b/docs/content/en/reference/mesheryctl/_index.md index e4fa8800829b6..d59d4d7821c72 100644 --- a/docs/content/en/reference/mesheryctl/_index.md +++ b/docs/content/en/reference/mesheryctl/_index.md @@ -93,6 +93,6 @@ Installation, troubleshooting and debugging of Meshery and its adapters ## Frequently Asked Questions for Meshery CLI -Refer to the following [frequently asked questions](/guides/mesheryctl/working-with-mesheryctl) related to Meshery CLI. +Refer to the following [frequently asked questions]({{< ref "guides/mesheryctl/working-with-mesheryctl.md" >}}) related to Meshery CLI. ## See Also diff --git a/docs/content/en/reference/mesheryctl/adapter/_index.md b/docs/content/en/reference/mesheryctl/adapter/_index.md index 84df630d1c424..897d8e2a45d9f 100644 --- a/docs/content/en/reference/mesheryctl/adapter/_index.md +++ b/docs/content/en/reference/mesheryctl/adapter/_index.md @@ -35,4 +35,4 @@ Provisioning, configuration, and on-going operational management of cloud and cl ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/adapter/deploy.md b/docs/content/en/reference/mesheryctl/adapter/deploy.md index 7dd690a8e2091..c139b858f0bc1 100644 --- a/docs/content/en/reference/mesheryctl/adapter/deploy.md +++ b/docs/content/en/reference/mesheryctl/adapter/deploy.md @@ -85,8 +85,8 @@ mesheryctl adapter deploy linkerd --watch ## Screenshots Usage of mesheryctl adapter deploy -![mesh-deploy-usage](/reference/images/deploy-mesh.png) +![mesh-deploy-usage](../../../images/deploy-mesh.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/adapter/remove.md b/docs/content/en/reference/mesheryctl/adapter/remove.md index 34e8ddb363486..694d854d367e0 100644 --- a/docs/content/en/reference/mesheryctl/adapter/remove.md +++ b/docs/content/en/reference/mesheryctl/adapter/remove.md @@ -67,4 +67,4 @@ mesheryctl adapter remove linkerd --namespace linkerd-ns ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/adapter/validate.md b/docs/content/en/reference/mesheryctl/adapter/validate.md index 37f2dbebf5c76..d414c98064d22 100644 --- a/docs/content/en/reference/mesheryctl/adapter/validate.md +++ b/docs/content/en/reference/mesheryctl/adapter/validate.md @@ -63,8 +63,8 @@ mesheryctl adapter validate istio --adapter meshery-istio --spec smi ## Screenshots Usage of mesheryctl adapter validate -![mesh-validate-usage](/reference/images/mesh-validate.png) +![mesh-validate-usage](../../../images/mesh-validate.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/completion.md b/docs/content/en/reference/mesheryctl/completion.md index df331c4a11655..4a9b6bd65d7a1 100644 --- a/docs/content/en/reference/mesheryctl/completion.md +++ b/docs/content/en/reference/mesheryctl/completion.md @@ -131,4 +131,4 @@ mesheryctl completion fish > ~/.config/fish/completions/mesheryctl.fish ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/component/_index.md b/docs/content/en/reference/mesheryctl/component/_index.md index 8a1cb6cd99d01..85730840cfc4b 100644 --- a/docs/content/en/reference/mesheryctl/component/_index.md +++ b/docs/content/en/reference/mesheryctl/component/_index.md @@ -76,4 +76,4 @@ mesheryctl component view [component-name | component-id] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/component/list.md b/docs/content/en/reference/mesheryctl/component/list.md index 4ebef7921ab27..c0d2f99492cab 100644 --- a/docs/content/en/reference/mesheryctl/component/list.md +++ b/docs/content/en/reference/mesheryctl/component/list.md @@ -78,4 +78,4 @@ mesheryctl component list --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/component/search.md b/docs/content/en/reference/mesheryctl/component/search.md index a83a4f9ca5069..4911642683556 100644 --- a/docs/content/en/reference/mesheryctl/component/search.md +++ b/docs/content/en/reference/mesheryctl/component/search.md @@ -69,4 +69,4 @@ mesheryctl component search [query-text] [--page 1] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/component/view.md b/docs/content/en/reference/mesheryctl/component/view.md index 8539e716f53ff..b612774d3b9df 100644 --- a/docs/content/en/reference/mesheryctl/component/view.md +++ b/docs/content/en/reference/mesheryctl/component/view.md @@ -69,4 +69,4 @@ mesheryctl component view [component-name | component-id] -o [json|yaml] --save ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/connection/_index.md b/docs/content/en/reference/mesheryctl/connection/_index.md index 342f759f07b49..0708ed2a1a785 100644 --- a/docs/content/en/reference/mesheryctl/connection/_index.md +++ b/docs/content/en/reference/mesheryctl/connection/_index.md @@ -104,4 +104,4 @@ mesheryctl connection delete [connection_id] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/connection/create.md b/docs/content/en/reference/mesheryctl/connection/create.md index 08a4ea0d67ca5..7c5f09c5a71c0 100644 --- a/docs/content/en/reference/mesheryctl/connection/create.md +++ b/docs/content/en/reference/mesheryctl/connection/create.md @@ -81,4 +81,4 @@ mesheryctl connection create --type gke --token auth.json ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/connection/delete.md b/docs/content/en/reference/mesheryctl/connection/delete.md index 953307c1a450d..10c22a24aefa8 100644 --- a/docs/content/en/reference/mesheryctl/connection/delete.md +++ b/docs/content/en/reference/mesheryctl/connection/delete.md @@ -50,4 +50,4 @@ mesheryctl connection delete [connection_id] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/connection/list.md b/docs/content/en/reference/mesheryctl/connection/list.md index 042b4d2b184f3..8b8560544e2c3 100644 --- a/docs/content/en/reference/mesheryctl/connection/list.md +++ b/docs/content/en/reference/mesheryctl/connection/list.md @@ -88,4 +88,4 @@ mesheryctl connection list --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/connection/view.md b/docs/content/en/reference/mesheryctl/connection/view.md index 6a8ef393d2126..f5e5ebe7bd4e0 100644 --- a/docs/content/en/reference/mesheryctl/connection/view.md +++ b/docs/content/en/reference/mesheryctl/connection/view.md @@ -69,4 +69,4 @@ mesheryctl connection view [connection-name|connection-id] --output-format json ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/_index.md b/docs/content/en/reference/mesheryctl/design/_index.md index 6f34480ad99d7..d2268f5c53774 100644 --- a/docs/content/en/reference/mesheryctl/design/_index.md +++ b/docs/content/en/reference/mesheryctl/design/_index.md @@ -76,4 +76,4 @@ mesheryctl design list ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/apply.md b/docs/content/en/reference/mesheryctl/design/apply.md index 3a1e48a9cb5b5..90440b5f7dd55 100644 --- a/docs/content/en/reference/mesheryctl/design/apply.md +++ b/docs/content/en/reference/mesheryctl/design/apply.md @@ -62,8 +62,8 @@ mesheryctl design apply [design-name] ## Screenshots Usage of mesheryctl design apply -![pattern-apply-usage](/reference/images/patternApply.png) +![pattern-apply-usage](../../../images/patternApply.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/delete.md b/docs/content/en/reference/mesheryctl/design/delete.md index 2b96907772aa3..34f51189d7607 100644 --- a/docs/content/en/reference/mesheryctl/design/delete.md +++ b/docs/content/en/reference/mesheryctl/design/delete.md @@ -52,4 +52,4 @@ mesheryctl design delete [file | URL] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/deploy.md b/docs/content/en/reference/mesheryctl/design/deploy.md index 9c51df77d6f3f..2d57bab6b9726 100644 --- a/docs/content/en/reference/mesheryctl/design/deploy.md +++ b/docs/content/en/reference/mesheryctl/design/deploy.md @@ -55,8 +55,8 @@ mesheryctl design deploy -f [filepath] -s [source type] ## Screenshots Usage of mesheryctl design deploy -![pattern-onboard-usage](/reference/images/pattern-onboard.png) +![pattern-onboard-usage](../../../images/app-onboard.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/export.md b/docs/content/en/reference/mesheryctl/design/export.md index c41221154d802..adfa40c88213f 100644 --- a/docs/content/en/reference/mesheryctl/design/export.md +++ b/docs/content/en/reference/mesheryctl/design/export.md @@ -81,4 +81,4 @@ mesheryctl design export [pattern-name | ID] --type [design-type] --output ./exp ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/import.md b/docs/content/en/reference/mesheryctl/design/import.md index b6d9d676d6137..6426b3d6bad9b 100644 --- a/docs/content/en/reference/mesheryctl/design/import.md +++ b/docs/content/en/reference/mesheryctl/design/import.md @@ -83,4 +83,4 @@ mesheryctl design import -f design.yml -s "Kubernetes Manifest" -n design-name ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/list.md b/docs/content/en/reference/mesheryctl/design/list.md index 34e4a58728873..19128ace2ef52 100644 --- a/docs/content/en/reference/mesheryctl/design/list.md +++ b/docs/content/en/reference/mesheryctl/design/list.md @@ -88,8 +88,8 @@ mesheryctl design list --count ## Screenshots Usage of mesheryctl design list -![pattern-list-usage](/reference/images/patternList.png) +![pattern-list-usage](../../../images/patternList.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/undeploy.md b/docs/content/en/reference/mesheryctl/design/undeploy.md index fe85a116a829b..02d4493095670 100644 --- a/docs/content/en/reference/mesheryctl/design/undeploy.md +++ b/docs/content/en/reference/mesheryctl/design/undeploy.md @@ -52,4 +52,4 @@ mesheryctl design undeploy -f [filepath] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/design/view.md b/docs/content/en/reference/mesheryctl/design/view.md index d5b99b1c46a8d..85cbd93f52445 100644 --- a/docs/content/en/reference/mesheryctl/design/view.md +++ b/docs/content/en/reference/mesheryctl/design/view.md @@ -54,8 +54,8 @@ mesheryctl design view [design-name | ID] ## Screenshots Usage of mesheryctl design view -![pattern-view-usage](/reference/images/patternView.png) +![pattern-view-usage](../../../images/patternView.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/environment/_index.md b/docs/content/en/reference/mesheryctl/environment/_index.md index 927a423a52aba..a189a888b7f7a 100644 --- a/docs/content/en/reference/mesheryctl/environment/_index.md +++ b/docs/content/en/reference/mesheryctl/environment/_index.md @@ -75,4 +75,4 @@ mesheryctl environment view --orgId [orgId] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/environment/create.md b/docs/content/en/reference/mesheryctl/environment/create.md index dbb0a707c98fe..949bee2918218 100644 --- a/docs/content/en/reference/mesheryctl/environment/create.md +++ b/docs/content/en/reference/mesheryctl/environment/create.md @@ -54,4 +54,4 @@ mesheryctl environment create --orgId [orgId] --name [name] --description [descr ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/environment/delete.md b/docs/content/en/reference/mesheryctl/environment/delete.md index 1846fc3263250..e210bb2f6ef11 100644 --- a/docs/content/en/reference/mesheryctl/environment/delete.md +++ b/docs/content/en/reference/mesheryctl/environment/delete.md @@ -51,4 +51,4 @@ mesheryctl environment delete [environmentId] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/environment/list.md b/docs/content/en/reference/mesheryctl/environment/list.md index 1c0b376a3ccb5..8f6fd983df735 100644 --- a/docs/content/en/reference/mesheryctl/environment/list.md +++ b/docs/content/en/reference/mesheryctl/environment/list.md @@ -79,4 +79,4 @@ mesheryctl environment list --orgId [orgId] --pagesize [pagesize] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/environment/view.md b/docs/content/en/reference/mesheryctl/environment/view.md index a5057d3b8d8fd..0ac4384c32ca9 100644 --- a/docs/content/en/reference/mesheryctl/environment/view.md +++ b/docs/content/en/reference/mesheryctl/environment/view.md @@ -54,4 +54,4 @@ mesheryctl environment view --orgId [orgId] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/exp.md b/docs/content/en/reference/mesheryctl/exp.md index a13f15543cfaa..bb3960282c3b3 100644 --- a/docs/content/en/reference/mesheryctl/exp.md +++ b/docs/content/en/reference/mesheryctl/exp.md @@ -40,4 +40,4 @@ mesheryctl exp [flags] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/filter/_index.md b/docs/content/en/reference/mesheryctl/filter/_index.md index 228a92530f626..15ed099a03b04 100644 --- a/docs/content/en/reference/mesheryctl/filter/_index.md +++ b/docs/content/en/reference/mesheryctl/filter/_index.md @@ -52,4 +52,4 @@ mesheryctl filter [subcommands] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/filter/delete.md b/docs/content/en/reference/mesheryctl/filter/delete.md index 3ed5d26638ae1..55d79907259b4 100644 --- a/docs/content/en/reference/mesheryctl/filter/delete.md +++ b/docs/content/en/reference/mesheryctl/filter/delete.md @@ -52,4 +52,4 @@ mesheryctl filter delete [filter-name | ID] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/filter/import.md b/docs/content/en/reference/mesheryctl/filter/import.md index acbe036cc5bff..4ec151f9cd96f 100644 --- a/docs/content/en/reference/mesheryctl/filter/import.md +++ b/docs/content/en/reference/mesheryctl/filter/import.md @@ -79,4 +79,4 @@ mesheryctl filter import /path/to/filter.wasm --name [string] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/filter/list.md b/docs/content/en/reference/mesheryctl/filter/list.md index 6d3021c2e00a3..82fca8a93f72a 100644 --- a/docs/content/en/reference/mesheryctl/filter/list.md +++ b/docs/content/en/reference/mesheryctl/filter/list.md @@ -68,4 +68,4 @@ mesheryctl filter list 'Test Filter' (maximum 25 filters) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/filter/view.md b/docs/content/en/reference/mesheryctl/filter/view.md index 8b92109320fe6..2f4f6673321bf 100644 --- a/docs/content/en/reference/mesheryctl/filter/view.md +++ b/docs/content/en/reference/mesheryctl/filter/view.md @@ -94,4 +94,4 @@ mesheryctl filter view "filter name" ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/_index.md b/docs/content/en/reference/mesheryctl/model/_index.md index f8ffba38e3c69..780b04193b968 100644 --- a/docs/content/en/reference/mesheryctl/model/_index.md +++ b/docs/content/en/reference/mesheryctl/model/_index.md @@ -139,4 +139,4 @@ mesheryctl model build [model-name]/[model-version] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/build.md b/docs/content/en/reference/mesheryctl/model/build.md index 38e3a61303083..45be82514cc5a 100644 --- a/docs/content/en/reference/mesheryctl/model/build.md +++ b/docs/content/en/reference/mesheryctl/model/build.md @@ -68,4 +68,4 @@ mesheryctl model build [model-name]/[model-version] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/delete.md b/docs/content/en/reference/mesheryctl/model/delete.md index 65eab3dfe9445..0326b1d6b366f 100644 --- a/docs/content/en/reference/mesheryctl/model/delete.md +++ b/docs/content/en/reference/mesheryctl/model/delete.md @@ -59,4 +59,4 @@ mesheryctl model delete [model-name] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/export.md b/docs/content/en/reference/mesheryctl/model/export.md index 3201fa251b9e7..e30f7d9fe8e75 100644 --- a/docs/content/en/reference/mesheryctl/model/export.md +++ b/docs/content/en/reference/mesheryctl/model/export.md @@ -90,4 +90,4 @@ mesheryctl model export [model-name] --version [version (ex: v0.7.3)] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/generate.md b/docs/content/en/reference/mesheryctl/model/generate.md index 1f0bcaf5deab6..4b6d687f5c375 100644 --- a/docs/content/en/reference/mesheryctl/model/generate.md +++ b/docs/content/en/reference/mesheryctl/model/generate.md @@ -70,4 +70,4 @@ mesheryctl model generate --file [URL] --template [path-to-template.json] --skip ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/import.md b/docs/content/en/reference/mesheryctl/model/import.md index a37646cf54932..5ef42158f2c1e 100644 --- a/docs/content/en/reference/mesheryctl/model/import.md +++ b/docs/content/en/reference/mesheryctl/model/import.md @@ -92,4 +92,4 @@ mesheryctl model import --file [path-to-csv-directory] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/init.md b/docs/content/en/reference/mesheryctl/model/init.md index 66b1b6f59789d..5f326deadd32f 100644 --- a/docs/content/en/reference/mesheryctl/model/init.md +++ b/docs/content/en/reference/mesheryctl/model/init.md @@ -85,4 +85,4 @@ mesheryctl model init [model-name] --output-format [json|yaml|csv] (default is j ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/list.md b/docs/content/en/reference/mesheryctl/model/list.md index eaa6df4d4c855..0c0312f7aa6cf 100644 --- a/docs/content/en/reference/mesheryctl/model/list.md +++ b/docs/content/en/reference/mesheryctl/model/list.md @@ -77,4 +77,4 @@ mesheryctl model list --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/search.md b/docs/content/en/reference/mesheryctl/model/search.md index cdca9d59413ea..abca992c38908 100644 --- a/docs/content/en/reference/mesheryctl/model/search.md +++ b/docs/content/en/reference/mesheryctl/model/search.md @@ -69,4 +69,4 @@ mesheryctl model search [query-text] --pagesize [pagesize-number] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/model/view.md b/docs/content/en/reference/mesheryctl/model/view.md index 7f6b265dcadd5..97cda4323dc24 100644 --- a/docs/content/en/reference/mesheryctl/model/view.md +++ b/docs/content/en/reference/mesheryctl/model/view.md @@ -69,4 +69,4 @@ mesheryctl model view [model-name] --output-format [json|yaml] --save ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/organization/_index.md b/docs/content/en/reference/mesheryctl/organization/_index.md index f102df55f2035..487a10cc0b958 100644 --- a/docs/content/en/reference/mesheryctl/organization/_index.md +++ b/docs/content/en/reference/mesheryctl/organization/_index.md @@ -60,4 +60,4 @@ mesheryctl organization list ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/organization/list.md b/docs/content/en/reference/mesheryctl/organization/list.md index 456a34374c469..24e2cbac17f94 100644 --- a/docs/content/en/reference/mesheryctl/organization/list.md +++ b/docs/content/en/reference/mesheryctl/organization/list.md @@ -70,4 +70,4 @@ mesheryctl organization list --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/perf/_index.md b/docs/content/en/reference/mesheryctl/perf/_index.md index 09c0875b89bad..e9f0dc39634ee 100644 --- a/docs/content/en/reference/mesheryctl/perf/_index.md +++ b/docs/content/en/reference/mesheryctl/perf/_index.md @@ -85,4 +85,4 @@ mesheryctl perf result -o yaml ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/perf/apply.md b/docs/content/en/reference/mesheryctl/perf/apply.md index e27c86c13bf65..3ae74890585bb 100644 --- a/docs/content/en/reference/mesheryctl/perf/apply.md +++ b/docs/content/en/reference/mesheryctl/perf/apply.md @@ -147,8 +147,8 @@ mesheryctl perf apply meshery-profile-new --url "https://google.com" --load-gene ## Screenshots Usage of mesheryctl perf apply -![perf-apply-usage](/reference/images/perf-apply.png) +![perf-apply-usage](../../../images/perf-apply.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/perf/profile.md b/docs/content/en/reference/mesheryctl/perf/profile.md index a4b6460c35b96..cc770e54e62ef 100644 --- a/docs/content/en/reference/mesheryctl/perf/profile.md +++ b/docs/content/en/reference/mesheryctl/perf/profile.md @@ -71,4 +71,4 @@ mesheryctl perf profile test --view ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/perf/result.md b/docs/content/en/reference/mesheryctl/perf/result.md index 7b5a97aaf3b90..28eba0ae89040 100644 --- a/docs/content/en/reference/mesheryctl/perf/result.md +++ b/docs/content/en/reference/mesheryctl/perf/result.md @@ -72,8 +72,8 @@ mesheryctl perf result saturday-profile --view ## Screenshots Usage of mesheryctl perf result -![perf-result-usage](/reference/images/perf-result.png) +![perf-result-usage](../../../images/perf-result.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/registry/_index.md b/docs/content/en/reference/mesheryctl/registry/_index.md index 4f0512a7a78d2..0cf8b76d68f72 100644 --- a/docs/content/en/reference/mesheryctl/registry/_index.md +++ b/docs/content/en/reference/mesheryctl/registry/_index.md @@ -50,4 +50,4 @@ mesheryctl registry [subcommand] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/registry/generate.md b/docs/content/en/reference/mesheryctl/registry/generate.md index 0d1250a5d4a8e..cac0509f78ccb 100644 --- a/docs/content/en/reference/mesheryctl/registry/generate.md +++ b/docs/content/en/reference/mesheryctl/registry/generate.md @@ -111,4 +111,4 @@ mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tu ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/registry/publish.md b/docs/content/en/reference/mesheryctl/registry/publish.md index 148de215171d4..7174790501bf4 100644 --- a/docs/content/en/reference/mesheryctl/registry/publish.md +++ b/docs/content/en/reference/mesheryctl/registry/publish.md @@ -107,4 +107,4 @@ mesheryctl registry publish website "$CRED" 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdw ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/registry/update.md b/docs/content/en/reference/mesheryctl/registry/update.md index 423b4bdb39e3c..8bdcdb7c83e92 100644 --- a/docs/content/en/reference/mesheryctl/registry/update.md +++ b/docs/content/en/reference/mesheryctl/registry/update.md @@ -71,4 +71,4 @@ mesheryctl registry update --spreadsheet-id 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdw ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/relationship/_index.md b/docs/content/en/reference/mesheryctl/relationship/_index.md index a3a924d94e15d..c30c21a8fef1d 100644 --- a/docs/content/en/reference/mesheryctl/relationship/_index.md +++ b/docs/content/en/reference/mesheryctl/relationship/_index.md @@ -85,4 +85,4 @@ mesheryctl relationship view [model-name] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/relationship/generate.md b/docs/content/en/reference/mesheryctl/relationship/generate.md index 54ce10fc2aa8c..7526f0d08a1ac 100644 --- a/docs/content/en/reference/mesheryctl/relationship/generate.md +++ b/docs/content/en/reference/mesheryctl/relationship/generate.md @@ -70,4 +70,4 @@ mesheryctl relationship generate --spreadsheet-id [Spreadsheet ID] --spreadsheet ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/relationship/list.md b/docs/content/en/reference/mesheryctl/relationship/list.md index 08c60bd2accea..1d640f498e733 100644 --- a/docs/content/en/reference/mesheryctl/relationship/list.md +++ b/docs/content/en/reference/mesheryctl/relationship/list.md @@ -77,4 +77,4 @@ mesheryctl relationship list --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/relationship/search.md b/docs/content/en/reference/mesheryctl/relationship/search.md index 80f4e6defe7e8..2037b873f0de5 100644 --- a/docs/content/en/reference/mesheryctl/relationship/search.md +++ b/docs/content/en/reference/mesheryctl/relationship/search.md @@ -63,4 +63,4 @@ mesheryctl relationship search [--kind ] [--page ] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/relationship/view.md b/docs/content/en/reference/mesheryctl/relationship/view.md index 8f9cbeb90a86e..fe4db291d0b3b 100644 --- a/docs/content/en/reference/mesheryctl/relationship/view.md +++ b/docs/content/en/reference/mesheryctl/relationship/view.md @@ -68,4 +68,4 @@ mesheryctl relationship view [model-name] --output-format json --save ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/_index.md b/docs/content/en/reference/mesheryctl/system/_index.md index 140028caae1ae..92841576b9abe 100644 --- a/docs/content/en/reference/mesheryctl/system/_index.md +++ b/docs/content/en/reference/mesheryctl/system/_index.md @@ -42,4 +42,4 @@ mesheryctl system [flags] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/channel/_index.md b/docs/content/en/reference/mesheryctl/system/channel/_index.md index 6ed9794ebdce7..ce9848ec992cd 100644 --- a/docs/content/en/reference/mesheryctl/system/channel/_index.md +++ b/docs/content/en/reference/mesheryctl/system/channel/_index.md @@ -85,4 +85,4 @@ mesheryctl system channel switch [stable|stable-version|edge|edge-version] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/channel/set.md b/docs/content/en/reference/mesheryctl/system/channel/set.md index 02476d81f6685..7de0b4d34c938 100644 --- a/docs/content/en/reference/mesheryctl/system/channel/set.md +++ b/docs/content/en/reference/mesheryctl/system/channel/set.md @@ -53,4 +53,4 @@ mesheryctl system channel set [stable|stable-version|edge|edge-version] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/channel/switch.md b/docs/content/en/reference/mesheryctl/system/channel/switch.md index ade568aca6446..e36854d093def 100644 --- a/docs/content/en/reference/mesheryctl/system/channel/switch.md +++ b/docs/content/en/reference/mesheryctl/system/channel/switch.md @@ -53,4 +53,4 @@ mesheryctl system channel switch [stable|stable-version|edge|edge-version] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/channel/view.md b/docs/content/en/reference/mesheryctl/system/channel/view.md index d7bd547e9eef1..38420965681e6 100644 --- a/docs/content/en/reference/mesheryctl/system/channel/view.md +++ b/docs/content/en/reference/mesheryctl/system/channel/view.md @@ -62,4 +62,4 @@ mesheryctl system channel view --all ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/check.md b/docs/content/en/reference/mesheryctl/system/check.md index f5a960cae8de2..22beaee9fcffd 100644 --- a/docs/content/en/reference/mesheryctl/system/check.md +++ b/docs/content/en/reference/mesheryctl/system/check.md @@ -107,8 +107,8 @@ mesheryctl system check --operator ## Screenshots Usage of mesheryctl system check -![check-usage](/reference/images/check.png) +![check-usage](../../../images/check.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/_index.md b/docs/content/en/reference/mesheryctl/system/context/_index.md index 24a42b6b89d2c..cce2035369d2e 100644 --- a/docs/content/en/reference/mesheryctl/system/context/_index.md +++ b/docs/content/en/reference/mesheryctl/system/context/_index.md @@ -53,4 +53,4 @@ mesheryctl system context ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/create.md b/docs/content/en/reference/mesheryctl/system/context/create.md index bd8ea4b218d29..9312edd9514a2 100644 --- a/docs/content/en/reference/mesheryctl/system/context/create.md +++ b/docs/content/en/reference/mesheryctl/system/context/create.md @@ -67,8 +67,8 @@ mesheryctl system context create [context-name] --components [meshery-nsm] --pla ## Screenshots Usage of mesheryctl context create -![context-create-usage](/reference/images/newcontext.png) +![context-create-usage](../../../../images/newcontext.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/delete.md b/docs/content/en/reference/mesheryctl/system/context/delete.md index 9d7f3de9e7466..5080b8b9775c0 100644 --- a/docs/content/en/reference/mesheryctl/system/context/delete.md +++ b/docs/content/en/reference/mesheryctl/system/context/delete.md @@ -54,4 +54,4 @@ mesheryctl system context delete [context name] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/list.md b/docs/content/en/reference/mesheryctl/system/context/list.md index 1872eded4d5ed..4b6e1ddb365bf 100644 --- a/docs/content/en/reference/mesheryctl/system/context/list.md +++ b/docs/content/en/reference/mesheryctl/system/context/list.md @@ -53,4 +53,4 @@ mesheryctl system context list ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/switch.md b/docs/content/en/reference/mesheryctl/system/context/switch.md index c47e7931902b4..0bcf580b12066 100644 --- a/docs/content/en/reference/mesheryctl/system/context/switch.md +++ b/docs/content/en/reference/mesheryctl/system/context/switch.md @@ -54,8 +54,8 @@ mesheryctl system context switch sample ## Screenshots Usage of mesheryctl context switch -![context-switch-usage](/reference/images/contextswitch.png) +![context-switch-usage](../../../../images/contextswitch.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/context/view.md b/docs/content/en/reference/mesheryctl/system/context/view.md index 422da2016ea6d..908b665593b43 100644 --- a/docs/content/en/reference/mesheryctl/system/context/view.md +++ b/docs/content/en/reference/mesheryctl/system/context/view.md @@ -88,8 +88,8 @@ mesheryctl system context view --all ## Screenshots Usage of mesheryctl context view -![context-view-usage](/reference/images/context-view.png) +![context-view-usage](../../../../images/context-view.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/dashboard.md b/docs/content/en/reference/mesheryctl/system/dashboard.md index c992abfdefba1..0eee7c064a674 100644 --- a/docs/content/en/reference/mesheryctl/system/dashboard.md +++ b/docs/content/en/reference/mesheryctl/system/dashboard.md @@ -83,4 +83,4 @@ Note: Meshery's web-based user interface is embedded in Meshery Server and is av ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/delete.md b/docs/content/en/reference/mesheryctl/system/delete.md index 91b53cff4258c..7d5b3ba1d3c77 100644 --- a/docs/content/en/reference/mesheryctl/system/delete.md +++ b/docs/content/en/reference/mesheryctl/system/delete.md @@ -60,4 +60,4 @@ mesheryctl system delete -y ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/login.md b/docs/content/en/reference/mesheryctl/system/login.md index 76bec3d752bb4..c209f27444266 100644 --- a/docs/content/en/reference/mesheryctl/system/login.md +++ b/docs/content/en/reference/mesheryctl/system/login.md @@ -64,4 +64,4 @@ mesheryctl system login -p Meshery ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/logout.md b/docs/content/en/reference/mesheryctl/system/logout.md index 37ba71d75f034..fff87a5e22823 100644 --- a/docs/content/en/reference/mesheryctl/system/logout.md +++ b/docs/content/en/reference/mesheryctl/system/logout.md @@ -55,4 +55,4 @@ mesheryctl system logout ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/logs.md b/docs/content/en/reference/mesheryctl/system/logs.md index 4315ec15dcaac..3628daeac5788 100644 --- a/docs/content/en/reference/mesheryctl/system/logs.md +++ b/docs/content/en/reference/mesheryctl/system/logs.md @@ -70,4 +70,4 @@ mesheryctl system logs meshery-istio ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/_index.md b/docs/content/en/reference/mesheryctl/system/provider/_index.md index 1f95214340819..e7df58b433631 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/_index.md +++ b/docs/content/en/reference/mesheryctl/system/provider/_index.md @@ -84,4 +84,4 @@ mesheryctl system provider reset ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/list.md b/docs/content/en/reference/mesheryctl/system/provider/list.md index 8b3cb7db90231..8ecf5bb75aa7b 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/list.md +++ b/docs/content/en/reference/mesheryctl/system/provider/list.md @@ -52,4 +52,4 @@ mesheryctl system provider list ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/reset.md b/docs/content/en/reference/mesheryctl/system/provider/reset.md index 1e02145a90e7c..a3965327bbf73 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/reset.md +++ b/docs/content/en/reference/mesheryctl/system/provider/reset.md @@ -52,4 +52,4 @@ mesheryctl system provider reset ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/set.md b/docs/content/en/reference/mesheryctl/system/provider/set.md index 63b98ae24e126..db38a81c747b4 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/set.md +++ b/docs/content/en/reference/mesheryctl/system/provider/set.md @@ -53,4 +53,4 @@ mesheryctl system provider set [provider] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/switch.md b/docs/content/en/reference/mesheryctl/system/provider/switch.md index da20a1033249c..0e70ee8c4b0bd 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/switch.md +++ b/docs/content/en/reference/mesheryctl/system/provider/switch.md @@ -52,4 +52,4 @@ mesheryctl system provider switch [provider] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/provider/view.md b/docs/content/en/reference/mesheryctl/system/provider/view.md index e4809be7408c9..8b6b4b11cc07f 100644 --- a/docs/content/en/reference/mesheryctl/system/provider/view.md +++ b/docs/content/en/reference/mesheryctl/system/provider/view.md @@ -53,4 +53,4 @@ mesheryctl system provider view ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/reset.md b/docs/content/en/reference/mesheryctl/system/reset.md index 6b92af00f4313..0f88797e7ac8c 100644 --- a/docs/content/en/reference/mesheryctl/system/reset.md +++ b/docs/content/en/reference/mesheryctl/system/reset.md @@ -54,8 +54,8 @@ mesheryctl system reset ## Screenshots Usage of mesheryctl system reset -![reset-usage](/reference/images/reset.png) +![reset-usage](../../../images/reset.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/restart.md b/docs/content/en/reference/mesheryctl/system/restart.md index 4fba2eb1a81c9..e7e470de1fa0a 100644 --- a/docs/content/en/reference/mesheryctl/system/restart.md +++ b/docs/content/en/reference/mesheryctl/system/restart.md @@ -63,4 +63,4 @@ mesheryctl system restart --skip-update ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/start.md b/docs/content/en/reference/mesheryctl/system/start.md index cbebd433a1c9c..3ef19e19c9fe8 100644 --- a/docs/content/en/reference/mesheryctl/system/start.md +++ b/docs/content/en/reference/mesheryctl/system/start.md @@ -97,4 +97,4 @@ mesheryctl system start --provider Meshery ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/status.md b/docs/content/en/reference/mesheryctl/system/status.md index abdb4905507bb..5ff2c12c4677d 100644 --- a/docs/content/en/reference/mesheryctl/system/status.md +++ b/docs/content/en/reference/mesheryctl/system/status.md @@ -61,8 +61,8 @@ mesheryctl system status --verbose ## Screenshots Usage of mesheryctl system status -![status-usage](/reference/images/status.png) +![status-usage](../../../images/status.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/stop.md b/docs/content/en/reference/mesheryctl/system/stop.md index 5c6aea79a88be..c87493c66f963 100644 --- a/docs/content/en/reference/mesheryctl/system/stop.md +++ b/docs/content/en/reference/mesheryctl/system/stop.md @@ -79,4 +79,4 @@ mesheryctl system stop --force ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/_index.md b/docs/content/en/reference/mesheryctl/system/token/_index.md index f667e89b2c6e9..b1fab0f52164e 100644 --- a/docs/content/en/reference/mesheryctl/system/token/_index.md +++ b/docs/content/en/reference/mesheryctl/system/token/_index.md @@ -43,4 +43,4 @@ mesheryctl system token [flags] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/create.md b/docs/content/en/reference/mesheryctl/system/token/create.md index d95aee365e787..0f6919f58c6d9 100644 --- a/docs/content/en/reference/mesheryctl/system/token/create.md +++ b/docs/content/en/reference/mesheryctl/system/token/create.md @@ -67,4 +67,4 @@ mesheryctl system token create [token-name] -f [token-path] --set ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/delete.md b/docs/content/en/reference/mesheryctl/system/token/delete.md index 6fb4d66c09d9a..3c61a4b762d15 100644 --- a/docs/content/en/reference/mesheryctl/system/token/delete.md +++ b/docs/content/en/reference/mesheryctl/system/token/delete.md @@ -51,4 +51,4 @@ mesheryctl system token delete [token-name] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/list.md b/docs/content/en/reference/mesheryctl/system/token/list.md index 1dd960eba7de8..e2504bedcd93c 100644 --- a/docs/content/en/reference/mesheryctl/system/token/list.md +++ b/docs/content/en/reference/mesheryctl/system/token/list.md @@ -51,4 +51,4 @@ mesheryctl system token list ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/set.md b/docs/content/en/reference/mesheryctl/system/token/set.md index 70b27e980f43a..4af16a8d4bc44 100644 --- a/docs/content/en/reference/mesheryctl/system/token/set.md +++ b/docs/content/en/reference/mesheryctl/system/token/set.md @@ -51,4 +51,4 @@ mesheryctl system token set [token-name] ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/token/view.md b/docs/content/en/reference/mesheryctl/system/token/view.md index e908287d45160..47b1c4109960e 100644 --- a/docs/content/en/reference/mesheryctl/system/token/view.md +++ b/docs/content/en/reference/mesheryctl/system/token/view.md @@ -59,4 +59,4 @@ mesheryctl system token view (show token of current context) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/system/update.md b/docs/content/en/reference/mesheryctl/system/update.md index 5d57d5598bb17..c9870dac118ba 100644 --- a/docs/content/en/reference/mesheryctl/system/update.md +++ b/docs/content/en/reference/mesheryctl/system/update.md @@ -62,8 +62,8 @@ mesheryctl system update --skip-reset ## Screenshots Usage of mesheryctl system update -![update-usage](/reference/images/update.png) +![update-usage](../../../images/update.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/version.md b/docs/content/en/reference/mesheryctl/version.md index b58f59880d889..89fc427797283 100644 --- a/docs/content/en/reference/mesheryctl/version.md +++ b/docs/content/en/reference/mesheryctl/version.md @@ -51,8 +51,8 @@ mesheryctl version ## Screenshots Usage of mesheryctl version -![version-usage](/reference/images/version.png) +![version-usage](../../images/version.png) ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/workspace/_index.md b/docs/content/en/reference/mesheryctl/workspace/_index.md index 5cf8d77753d35..4c690d2d7bca0 100644 --- a/docs/content/en/reference/mesheryctl/workspace/_index.md +++ b/docs/content/en/reference/mesheryctl/workspace/_index.md @@ -60,4 +60,4 @@ mesheryctl workspace create --orgId [orgId] --name [name] --description [descrip ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/workspace/create.md b/docs/content/en/reference/mesheryctl/workspace/create.md index bd46542cdf3d8..c453e62f6431b 100644 --- a/docs/content/en/reference/mesheryctl/workspace/create.md +++ b/docs/content/en/reference/mesheryctl/workspace/create.md @@ -54,4 +54,4 @@ mesheryctl workspace create --orgId [orgId] --name [name] --description [descrip ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/workspace/list.md b/docs/content/en/reference/mesheryctl/workspace/list.md index a1f92bf89d31d..3a3ed7541ef72 100644 --- a/docs/content/en/reference/mesheryctl/workspace/list.md +++ b/docs/content/en/reference/mesheryctl/workspace/list.md @@ -71,4 +71,4 @@ mesheryctl workspace list --orgId [orgId] --count ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/mesheryctl/workspace/view.md b/docs/content/en/reference/mesheryctl/workspace/view.md index f46237ffe7ec4..dcd80971be735 100644 --- a/docs/content/en/reference/mesheryctl/workspace/view.md +++ b/docs/content/en/reference/mesheryctl/workspace/view.md @@ -78,4 +78,4 @@ mesheryctl workspace view [workspace-id] --orgId [orgId] --output-format json -- ## See Also -Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance. +Go back to [command reference index]({{< ref "reference/mesheryctl/_index.md" >}}), if you want to add content manually to the CLI documentation, please refer to the [instruction]({{< ref "project/contributing/contributing-cli/index.md#preserving-manually-added-documentation" >}}) for guidance. diff --git a/docs/content/en/reference/permissions.md b/docs/content/en/reference/permissions.md index d1bf89b8ef17c..9725ee391b223 100644 --- a/docs/content/en/reference/permissions.md +++ b/docs/content/en/reference/permissions.md @@ -8,7 +8,7 @@ Permissions are represented as keys, each serving as a unique identifier {{% alert color="info" title="Customizable Permissions" %}}Default permissions can be easily customized by simply creating your own keychains and roles.{{% /alert %}} -{{% alert color="info" title="Contributing to Permission Keys" %}}To contribute permission keys, see the Authorization Extensibility Documentation. This guide explains Meshery's extensible authorization system.{{% /alert %}} +{{% alert color="info" title="Contributing to Permission Keys" %}}To contribute permission keys, see the Authorization Extensibility Documentation. This guide explains Meshery's extensible authorization system.{{% /alert %}}
      {{< permissions >}} diff --git a/docs/content/en/reference/rest-apis/_index.md b/docs/content/en/reference/rest-apis/_index.md index 3ccc4c08787e5..da07260d0b2d8 100644 --- a/docs/content/en/reference/rest-apis/_index.md +++ b/docs/content/en/reference/rest-apis/_index.md @@ -18,9 +18,9 @@ Each of Meshery's APIs is subject to Meshery's authentication and authorization
      Authentication - Requests to any of the API endpoints must be authenticated and include a valid JWT access token in the HTTP headers. The type of authentication is determined by the selected Providers. Use of the Local Provider, "None", puts Meshery into single-user mode and uses minimal, intentionally insecure authentication. + Requests to any of the API endpoints must be authenticated and include a valid JWT access token in the HTTP headers. The type of authentication is determined by the selected Providers. Use of the Local Provider, "None", puts Meshery into single-user mode and uses minimal, intentionally insecure authentication. - {{% alert color="dark" title="What are authentication tokens?" %}}Meshery authentication tokens allow users or systems to authenticate with Meshery Server via either its two clients, Meshery CLI and Meshery dashboard, or its two APIs: REST or GraphQL.

      Meshery's authentication token system provides secure access to Meshery's management features.

      {{% /alert %}} + {{% alert color="dark" title="What are authentication tokens?" %}}Meshery authentication tokens allow users or systems to authenticate with Meshery Server via either its two clients, Meshery CLI and Meshery dashboard, or its two APIs: REST or GraphQL.

      Meshery's authentication token system provides secure access to Meshery's management features.

      {{% /alert %}}
      ### How to get your token @@ -46,7 +46,7 @@ Using the Meshery dashboard, you can get a copy of your authentication token by 2. Navigate to your user's avatar in the upper righthand corner and select "Get Token" from the dropdown of profile section: -Meshery Dashboard +Meshery Dashboard
      @@ -54,7 +54,7 @@ Using the Meshery dashboard, you can get a copy of your authentication token by
      Meshery CLI
      -Using Meshery CLI, you can get a copy of your authentication token by executing the following command: +Using Meshery CLI, you can get a copy of your authentication token by executing the following command: 

      diff --git a/docs/content/en/reference/images/MesheryTokenUI.png b/docs/content/en/reference/rest-apis/images/MesheryTokenUI.png
similarity index 100%
rename from docs/content/en/reference/images/MesheryTokenUI.png
rename to docs/content/en/reference/rest-apis/images/MesheryTokenUI.png
diff --git a/docs/hugo.toml b/docs/hugo.toml
index 2f66264c3b294..30aedacc63ed1 100644
--- a/docs/hugo.toml
+++ b/docs/hugo.toml
@@ -1,6 +1,6 @@
 baseURL = "https://docs.meshery.io"
 title = "Documentation"
-relativeURLs = true
+relativeURLs = false
 canonifyURLs = false
 
 # Language settings
diff --git a/docs/i18n/en.toml b/docs/i18n/en.toml
index 6ebe7745c234b..1f48767b57b7e 100644
--- a/docs/i18n/en.toml
+++ b/docs/i18n/en.toml
@@ -12,7 +12,7 @@ other = "Read more"
 [ui_search]
 other = "Search"
 
-# Used in sentences such as "Posted in News"
+# Used in sentences such 
 [ui_in]
 other = "in"
 
diff --git a/docs/layouts/404.html b/docs/layouts/404.html
index e5d2ddf80b728..8d7ea1e83138a 100644
--- a/docs/layouts/404.html
+++ b/docs/layouts/404.html
@@ -3,7 +3,7 @@
   
      
   
      Things tend to get a bit meshy around here...
      
   
      
-    Please report this issue (thank you!) and return to the Meshery Documentation.
+    Please report this issue (thank you!) and return to the Meshery Documentation.
    @@ -26,4 +26,4 @@

    Things ten var message = messages[Math.floor(Math.random()*messages.length)]; document.getElementById("funny-message").innerHTML = message; -{{ end }} \ No newline at end of file +{{ end }} diff --git a/docs/layouts/adapters/list.html b/docs/layouts/adapters/list.html index 47549692f4d67..ecec934883882 100644 --- a/docs/layouts/adapters/list.html +++ b/docs/layouts/adapters/list.html @@ -6,7 +6,7 @@ {{ range where .Site.Pages "Type" "adapters" }} {{ if .Params.image }} - {{ .Params.name }} + {{ .Params.name }} {{ .Params.earliest_version }} {{ end }} diff --git a/docs/layouts/compatibility-matrix/single.html b/docs/layouts/compatibility-matrix/single.html index a85f35e691da0..13be74d965957 100644 --- a/docs/layouts/compatibility-matrix/single.html +++ b/docs/layouts/compatibility-matrix/single.html @@ -124,14 +124,16 @@

    {{ .Params.subheading }} Integration Tests

    {{ $comp }} {{ $version }} {{ index .Params "meshery-server-version" }} - {{ index .Params "service-mesh" }} + {{- $mesh := index .Params "service-mesh" | lower -}} + {{- $adapterContentPath := printf "content/en/extensions/adapters/%s/index.md" $mesh -}} + {{ if os.FileExists $adapterContentPath }}{{ index .Params "service-mesh" }}{{ else }}{{ index .Params "service-mesh" }}{{ end }} {{ index .Params "service-mesh-version" }} Platform: @@ -139,14 +141,14 @@

    {{ .Params.subheading }} Integration Tests

    {{- if index .Params "tests" -}} {{- range $pod, $status := index .Params "tests" -}} - {{- $test_icon := "/installation/compatibility-matrix/images/service-meshes/passing.svg" -}} + {{- $test_icon := "installation/compatibility-matrix/images/service-meshes/passing.svg" -}} {{- if eq (trim $status " ") "Running" -}} - {{- $test_icon = "/installation/compatibility-matrix/images/service-meshes/passing.svg" -}} + {{- $test_icon = "installation/compatibility-matrix/images/service-meshes/passing.svg" -}} {{- else -}} - {{- $test_icon = "/installation/compatibility-matrix/images/service-meshes/failing.svg" -}} + {{- $test_icon = "installation/compatibility-matrix/images/service-meshes/failing.svg" -}} {{- end -}} - + {{- end -}} @@ -186,14 +188,16 @@

    {{ .Params.subheading }} Integration Tests

    - + {{- $mesh := index .Params "service-mesh" | lower -}} + {{- $adapterContentPath := printf "content/en/extensions/adapters/%s/index.md" $mesh -}} +
    Test StatusTest Status {{ $pod }}
    {{ $comp }} {{ index .Params "meshery-component-version" }} {{ index .Params "meshery-server-version" }}{{ index .Params "service-mesh" }}{{ if os.FileExists $adapterContentPath }}{{ index .Params "service-mesh" }}{{ else }}{{ index .Params "service-mesh" }}{{ end }} {{ index .Params "service-mesh-version" }}