[Feat] - Migration of Content from Book to Docs - v2 (#131)

* Migration of Content from Book to Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Lint Issues

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links -v 3

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links

Signed-off-by: Adithya Krishna <[email protected]>

* Added Eslint MD Parser

Signed-off-by: Adithya Krishna <[email protected]>

* Moved Use Cases

Signed-off-by: Adithya Krishna <[email protected]>

---------

Signed-off-by: Adithya Krishna <[email protected]>

Author: Adithya Krishna

.eslintrc.js

@@ -21,6 +21,31 @@ module.exports = {
     'plugin:import/warnings',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:md/recommended',
+  ],
+  overrides: [
+    {
+      files: ['*.md'],
+      parser: 'markdown-eslint-parser',
+      rules: {
+        'prettier/prettier': [
+          'error',
+          // Important to force prettier to use "markdown" parser - otherwise it wouldn't be able to parse *.md files.
+          // You also can configure other options supported by prettier here - "prose-wrap" is
+          // particularly useful for *.md files
+          { parser: 'markdown' },
+        ],
+      },
+    },
+    {
+      files: ['*.md.js'], // Will match js code inside *.md files
+      rules: {
+        // Example - disable 2 core eslint rules 'no-unused-vars' and 'no-undef'
+        'no-unused-vars': 'off',
+        'no-undef': 'off',
+      },
+    },
   ],
   parserOptions: {
     ecmaFeatures: {

docs/develop/deploy/cri-runtime/containerd-crun.md

@@ -83,7 +83,7 @@ The args are as follows.
 File content is This is in a file
 ```
 
-Next, you can try to run it in [Kubernetes](../kubernetes/kubernetes-containerd-crun.md#a-simple-webassembly-app)!
+Next, you can try to run it in [Kubernetes](../kubernetes/kubernetes-containerd-crun.md#a-simple-webassembly-app))!
 
 ## Run a HTTP server app
 

docs/develop/deploy/kubernetes/_category_.json

@@ -1,8 +1,8 @@
 {
-  "label": "Use Cases",
-  "position": 6,
+  "label": "Kubernetes Use Cases",
+  "position": 7,
   "link": {
     "type": "generated-index",
-    "description": "In this chapter, we will introduce how to use K8s variations to depoloy Wasm app."
+    "description": "In this chapter, we will discuss how popular software applications embed WasmEdge to support extended functionalities."
   }
 }

docs/develop/deploy/kubernetes/knative.md

@@ -14,7 +14,7 @@ Here we setup crun as a runtimeClass in kubernetes cluster, **rather than replac
 
 ## Compile crun
 
-Please refer to the document [crun](../../deploy/oci-runtime/crun) to build and compile crun with WasmEdge support.
+Please refer to the document [crun](../../../develop/deploy/oci-runtime/crun) to build and compile crun with WasmEdge support.
 
 ```bash
 # Install dependencies

docs/develop/deploy/kubernetes/kubedge.md

@@ -8,7 +8,7 @@ KubeEdge is an open source system for extending native containerized application
 
 <!-- prettier-ignore -->
 :::note
-This demo is based on [crun's support](../../deploy/oci-runtime/crun)
+This demo is based on [crun's support](../../../develop/deploy/oci-runtime/crun)
 :::
 
 ## 1. Setup Cloud Side (KubeEdge Master Node)

docs/develop/deploy/kubernetes/kubernetes-containerd-crun.md

@@ -13,7 +13,7 @@ The [GitHub repo](https://github.com/second-state/wasmedge-containers-examples/)
 
 In the rest of this section, we will explain the steps in detail.
 
-We will assume that you have already [installed and configured containerd](../cri-runtime/containerd-crun.md) to work with WasmEdge container images.
+We will assume that you have already [installed and configured containerd](../../../develop/deploy/cri-runtime/containerd-crun) to work with WasmEdge container images.
 
 ## Install and start Kubernetes
 

docs/develop/deploy/kubernetes/kubernetes-cri-o.md

@@ -11,7 +11,7 @@ The [WasmEdge Containers Example](https://github.com/second-state/wasmedge-conta
 - Simple WebAssembly example [Quick start](https://github.com/second-state/wasmedge-containers-examples/blob/main/kubernetes_crio/README.md) | [Github Actions](https://github.com/second-state/wasmedge-containers-examples/blob/main/.github/workflows/kubernetes-crio.yml)
 - WebAssembly-based HTTP service [Quick start](https://github.com/second-state/wasmedge-containers-examples/blob/main/kubernetes_crio/http_server/README.md) | [Github Actions](https://github.com/second-state/wasmedge-containers-examples/blob/main/.github/workflows/kubernetes-crio-server.yml)
 
-In the rest of this section, we will explain the steps in detail. We will assume that you have already [installed and configured CRI-O](../oci-runtime/crun.md) to work with WasmEdge container images.
+In the rest of this section, we will explain the steps in detail. We will assume that you have already [installed and configured CRI-O](../../../develop/deploy/oci-runtime/crun) to work with WasmEdge container images.
 
 ## Install and start Kubernetes
 

docs/develop/deploy/kubernetes/openyurt.md

@@ -111,7 +111,7 @@ systemctl start containerd
 
 #### Install WasmEdge
 
-Use the [simple install script](../../build-and-run/install) to install WasmEdge on your edge node.
+Use the [simple install script](../../../develop/build-and-run/install) to install WasmEdge on your edge node.
 
 ```bash
 curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install.sh | bash

docs/develop/overview.md

@@ -19,7 +19,16 @@ We will cover the following content:
 - Develop WebAssembly apps from your programming languages from [Rust](/category/develop-wasm-apps-in-rust), [C/C++](/category/develop-wasm-apps-in-cc), [JavaScript](/category/develop-wasm-apps-in-javascript), [Go](/category/develop-wasm-apps-in-go), and many other languages.
 - [Deploy Wasm Apps with the existing container toolings](/category/deploy-wasmedge-apps-in-kubernetes)
 
-Besides this, we also have two more guides for embedding Wasm Functions and contributing to WasmEdge.
+# Write a WebAssembly Application
+
+A key value proposition of WebAssembly is that it supports multiple programming languages. WebAssembly is a "managed runtime" for many programming languages including [C/C++](/category/develop-wasm-apps-in-cc), [Rust](/category/develop-wasm-apps-in-rust), [Go](/category/develop-wasm-apps-in-go), and even [JavaScript](/category/develop-wasm-apps-in-javascript) and [Python](/category/develop-wasm-apps-in-python).
+
+- For compiled languages (e.g., C and Rust), WasmEdge WebAssembly provides a safe, secure, isolated, and containerized runtime as opposed to Native Client (NaCl).
+- For interpreted or managed languages (e.g., JavaScript and Python), WasmEdge WebAssembly provides a secure, fast, lightweight, and containerized runtime as opposed to Docker + guest OS + native interpreter.
+
+In this chapter, we will discuss how to compile sources into WebAssembly in different languages and run them in WasmEdge.
+
+Besides this, we also have two more guides for [Embedding Wasm Functions](/embed/overview) and [Contributing](/contribute/overview) to WasmEdge.
 
 If you find some issues or have any feedback, you could reach out to us via the following ways.
 

docs/develop/wasmedge/integrations.md

@@ -0,0 +1,37 @@
+---
+sidebar_position: 1
+---
+
+# WasmEdge Integrations
+
+WasmEdge is a "serverless" runtime for cloud native and edge computing applications. It allows developers safely embed third-party or "native" functions into a host application or a distributed computing framework.
+
+## Embed WasmEdge Into A Host Application
+
+A major use case of WasmEdge is to start a VM instance from a host application. Depending on your host application's programming language, you can use WasmEdge SDKs to start and invoke WasmEdge functions.
+
+- Embed WasmEdge functions into a `C`-based application using the [WasmEdge C API](/category/c-sdk-for-embedding-wasmedge). Checkout the [quick start guide](/embed/c/intro).
+- Embed WasmEdge functions into a `Go` application using the [WasmEdge Go API](/category/go-sdk-for-embedding-wasmedge). Here is a [tutorial](https://www.secondstate.io/articles/extend-golang-app-with-webassembly-rust/) and are some [examples](https://github.com/second-state/WasmEdge-go-examples)!
+- Embed WasmEdge functions into a `Rust` application using the [WasmEdge Rust crate](https://crates.io/crates/wasmedge-sdk).
+- Embed WasmEdge functions into a `Node.js` application using the `NAPI`. Here is a [tutorial](https://www.secondstate.io/articles/getting-started-with-rust-function/).
+- Embed WasmEdge functions into any application by spawning a new process. See examples for [Vercel Serverless Functions](https://www.secondstate.io/articles/vercel-wasmedge-webassembly-rust/) and [AWS Lambda](https://www.cncf.io/blog/2021/08/25/webassembly-serverless-functions-in-aws-lambda/).
+
+However, the WebAssembly spec only supports very limited data types as input parameters and return values for the WebAssembly bytecode functions. In order to pass complex data types, such as a string of an array, as call arguments into WebAssembly compiled from Rust, you should use the `bindgen` solution provided by the [`wasmedge-bindgen`](https://crates.io/crates/wasmedge-bindgen). We currently support the `wasmedge-bindgen` in the [Rust](/develop/rust/bindgen) and in [Go](/embed/go/bindgen).
+
+## Use WasmEdge As A Docker-Like Container
+
+WasmEdge provides an OCI compliant interface. You can use container tools, such as CRI-O, Docker Hub, and Kubernetes, to orchestrate and manage WasmEdge runtimes.
+
+- [Manage WasmEdge with CRI-O and Docker Hub](https://www.secondstate.io/articles/manage-webassembly-apps-in-wasmedge-using-docker-tools/).
+
+## Call Native Host Functions From WasmEdge
+
+A key feature of WasmEdge is its extensibility. WasmEdge APIs allow developers to register "host functions" from the host programming languages into a WasmEdge instance, and then invoke these functions from the WebAssembly program.
+
+- The WasmEdge C API supports the [C host functions](/embed/c/host_function).
+- The WasmEdge Go API supports the [Go host functions](https://github.com/second-state/WasmEdge-go-examples/tree/master/go_HostFunc#wasmedge-go-host-function-example).
+- The WasmEdge Rust API supports the [Rust host functions](https://github.com/second-state/wasmedge-rustsdk-examples/blob/main/README.md#host-functions).
+
+[Here is an example](https://www.secondstate.io/articles/call-native-functions-from-javascript/) of a JavaScript program in WasmEdge calling a C-based host function in the underlying OS.
+
+The host functions break the Wasm sandbox to access the underly OS or hardware. But the sandbox breaking is done with explicit permission from the system’s operator.