Update plugin information

[mhmohona]

Explanation

Updated existing plugin documentation.

Related issue

#85

What type of PR is this

/kind documentation

Proposed Changes

[alabulei1]

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.

---

Overall, the patch addresses a broken hyperlink in the ebpf.md file but introduces potential issues with inconsistency in the Chinese translation and trailing whitespace in some files. Additionally, the process.md file lacks instructions on how to install the WasmEdge-Process plugin. These issues should be addressed before merging the patch.

Details

Commit 6a5c4a884bae8bb4e4587aca8bbe3bdb44d1e2c3

Key Changes:

• Added a new FAQ page in the docs/develop/getting-started directory.
• Added a Chinese translation of the FAQ page in the i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started directory.
• The FAQ page includes 8 questions and answers related to WasmEdge and its usage.
• Each question includes a brief explanation or answer.

Potential Problems:

• The FAQ page seems to be well-written and provides useful information to users.
• No potential problems or issues were found in this patch.

Overall, this patch adds a new FAQ page to the project, which improves the documentation and provides answers to common questions about WasmEdge. The patch seems to be well-implemented and does not introduce any problems.

Commit 9b1027f2b4cf2d2c846106a7538744e00de7a954

Key Changes:

• Added documentation for the eBPF plugin, including instructions on how to build and use it.
• Added documentation for the Process plugin, including instructions on how to build and use it.
• Added documentation for the Rusttls plugin, including instructions on how to build and use it.

Potential Problems:

• There is one file (wasi_crypto.md) that was added to the plugin folder but is not mentioned in the patch. It is unclear why this file was added and if it should be included in the documentation.
• The instructions for building the eBPF plugin mention a specific version (libbpf >= 1.2) but do not provide information on how to install this version or check if it is already installed. Users may encounter issues if they don't have the required version installed.
• The instructions for building the Process plugin use the cmake --install command, which may require elevated privileges to install the plugin in the system directory (/usr/local/lib/wasmedge). This could cause issues for users without admin access.
• The instructions for using the Process plugin mention a flag (--process_plugin) to specify the path to the plugin, but it is unclear if this flag should be used with the wasmedge command or with the --dir flag.
• The instructions for building the Rusttls plugin mention installing Rust and CMake, but they do not provide version requirements. Users may encounter issues if they have incompatible versions installed.
• The instructions for building the Rusttls plugin mention using the cargo install --path . command, which installs the plugin into the Rust binary directory. It is unclear if this is the intended location for the plugin or if it should be installed in the WasmEdge plugin directory.

Overall, the patch adds useful documentation for the new plugins, but it could benefit from clarifications and additional information on certain steps.

Commit de9ceb8b9239ebe72b143ebacd4fcf5b73028f4b

Key changes:

• Updated the eBPF.md file to provide more detailed instructions on building and using the eBPF plugin.
• Updated the process.md file to correct the spelling of "plugin" and provide additional usage instructions.
• Updated the rusttls.md file to provide a step-by-step guide on building the Rustls plugin.

Potential problems:

• The patch does not include any deletions or modifications to existing content, so there shouldn't be any conflicts or regressions introduced.

Overall, the changes provide more comprehensive documentation for the plugins and improve the user experience by providing detailed instructions for building and using them.

Commit 0204599191b12fd6a81343120a27f4b03503826e

Key changes in the patch:

• Added links to the GitHub repositories for the eBPF plugin, Image plugin, and Process plugin in their respective documentation files.

Potential problems:

• The patch contains deletions of the docs/develop/getting-started/faq.md file and the i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started/faq.md file. These deletions need to be reviewed to ensure that they are intentional and do not remove important content.

Overall, the changes in the patch seem to improve the documentation by adding links to the GitHub repositories for the plugins. The deletions of the FAQ files need to be reviewed for potential issues.

Commit b2fa3538cd000fab6c43200e96b8318872a90c90

Key changes:

• Updated the hyperlink in the ebpf.md file to fix a broken link.

Potential problems:

• The hyperlink in the ebpf.md file was fixed, but the same change was not made in the Chinese translation (zh) of the file. This could cause inconsistency in the documentation.
• Some of the Markdown files have trailing whitespace at the end of lines. It is recommended to remove these to maintain consistent formatting.
• In the process.md file, there is a comment that says the WasmEdge-Process plugin should be installed, but there are no instructions on how to install it. It would be helpful to provide installation instructions in the documentation.

[alabulei1]

May I ask where is the source for this doc?

[alabulei1]

May I ask where is the source for this doc?

[mhmohona]

This readme file - https://github.com/WasmEdge/WasmEdge/blob/master/plugins/wasm_bpf/README.md

[alabulei1]

Nice catch! Thanks for the PR. I have left some comments. Please take a look.