Skip to content

docs: update plugin introduction #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from

Conversation

mhmohona
Copy link
Contributor

@mhmohona mhmohona commented May 30, 2023

Explanation

Updated plugin PR adding more info about

  • What is a WasmEdge plugin?
  • How can WasmEdge plugins be used?
  • Benefits of using WasmEdge Plug-in System

Related issue

What type of PR is this

/kind documentation

Proposed Changes

Copy link
Collaborator

alabulei1 commented May 30, 2023

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


Overall, all the patches are minor and do not seem to cause any potential problems. Most of them involve fixing typos or updating the formatting of the WasmEdge plugin documentation. Some patches include adding an architecture diagram or updating the flowchart to better fit the document's flow. The most important finding is that the updates emphasize the key benefits of using the WasmEdge plugin system, such as versatility, customization, performance, and ease of use. The patches also highlight the importance of using plugins to improve scalability and simplify development on edge devices.

Details

Commit e831c822080e7527fc3fcf923ef1ff9c8bc37a21

Key Changes:

  • The introduction has been updated to provide more information about the WasmEdge plugin architecture and its benefits.
  • The text now explains that developers can use the WasmEdge plugin system to add new functionality to the runtime, customize the runtime, improve performance, and improve security.
  • The text also highlights the four key benefits of using the WasmEdge plugin system: versatility, customization, performance, and ease of use.
  • The updated text emphasizes that WasmEdge plugins can help to improve scalability and simplify the development of complex applications on edge devices.

Potential Problems:

  • There do not appear to be any major problems with this patch.

Commit 2b6ac2c0a3a00401f3f5d908870ce4bee545caff

Key changes:

  • An architecture diagram has been added to the document explaining the host application, plugin shared library, and Wasmedge runtime.

Potential problems:

  • No potential problems were found in this patch.

Commit 65fc73bfaf90c5bffb5d4e9b7930079acb8e7071

The patch updates the formatting of the introduction section of the plugin documentation. The changes involve replacing quotes with asterisks to highlight certain parts of the text. There are no potential problems identified in the patch and the changes seem minor. The only thing to note is that this patch is one of a series of nine patches, so there may be additional changes made in other patches that need to be reviewed as well.

Commit 2eeb7d58d500c030e5e34b71ff1681a5fac7b9c0

Key changes:

  • A typo has been fixed in the heading of the "Usages of WasmEdge Plugin" section of the "intro.md" file.

Potential problems:

  • There don't seem to be any potential problems with this patch. The changes are simple and straightforward, and the author has provided a clear explanation of what has been fixed.

Commit 6008f56d8426fcefaa8ee2da7da08131debdc185

Key changes:

  • A single typo has been fixed: "Benefits of Using WasmEdge Plugin System" has been changed to "Benefits of Using WasmEdge Plugin".

Potential problems:

  • None. This is a very minor change that fixes a typo.

Commit 67f2f5324ba19cd19b3788606bb875d2376ffbe4

Key Changes:

  • The patch updates the flowchart in the "docs/contribute/plugin/intro.md" file.
  • The patch also swaps the positions of the "Usages of WasmEdge Plugin" section and the flowchart.

Potential Problems:

  • No potential problems are found. The patch simply updates the flowchart and adjusts the position of a section to better fit the document's flow.

Commit f3a2b87d921ea81509eb26fc3ab8a0f010b1c6e4

The patch only contains the deletion of one line of text that was a blank line. The significant changes were made in another patch. There are no potential problems identified in this specific patch.

Commit a34b7facaf568f1cc950b34777d37f753259a56f

The key change in this patch is the removal of white space. Specifically, there was an additional blank line added before the introduction section. The patch removes this blank line.

There do not appear to be any major potential problems with this patch. However, it is a very small and simple change, and it may not be necessary to submit such a minor pull request.

Commit 54988d0ca52cedd498aa6cfa0ad9dcbbc26a62d2

Summary:

The patch updates the format of the introductory section of the WasmEdge plugin documentation. Instead of bulleted list items, headings are used to emphasize key points.

Key Changes:

  • Used headings to emphasize key points instead of bulleted list items.
  • Made each key point bold, making it easier to read and distinguish from the surrounding text.

Potential Problems:

Based on the patch, no potential problems can be identified. The changes seem to be formatting-related and do not affect the content of the documentation.

mhmohona added 4 commits May 30, 2023 08:59
Signed-off-by: Mahfuza Humayra Mohona mhmohona@gmail.com
Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>
Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>
Signed-off-by: mhmohona <mhmohona@gmail.com>
@alabulei1
Copy link
Collaborator

@mhmohona Could you please fix the DCO test first?

mhmohona added 3 commits June 5, 2023 10:50
Signed-off-by: mhmohona <mhmohona@gmail.com>
Signed-off-by: mahfuza <mhmohona@gmail.com>
@alabulei1
Copy link
Collaborator

alabulei1 commented Jun 6, 2023

@q82419 Could you please take a look?

@adithyaakrishna
Copy link
Contributor

@mhmohona Could you please fix the DCO check?

@q82419
Copy link
Collaborator

q82419 commented Jun 7, 2023

LGTM

Copy link
Contributor

@adithyaakrishna adithyaakrishna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhmohona Can we please make the above changes?

Signed-off-by: mahfuza <mhmohona@gmail.com>
@alabulei1
Copy link
Collaborator

Hi @mhmohona Please fix the DCO test and then we can merge this PR. Thanks.

@mhmohona
Copy link
Contributor Author

Reopened another PR to pass DOC test - #105

@mhmohona mhmohona closed this Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants