Skip to content

Commit

Permalink
Update docs for 0.14.1 and plug-in information. (#253)
Browse files Browse the repository at this point in the history
Signed-off-by: YiYing He <[email protected]>
  • Loading branch information
q82419 authored Sep 25, 2024
1 parent 0ed52dd commit 6e63e2e
Show file tree
Hide file tree
Showing 56 changed files with 891 additions and 703 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
WASMEDGE_VERSION='0.14.0'
WASMEDGE_VERSION='0.14.1'
WASMEDGE_GO_VERSION='0.13.4'
23 changes: 9 additions & 14 deletions docs/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ sidebar_position: 8

# Contributing Guide


* [New Contributor Guide](#contributing-guide)
* [Ways to Contribute](#ways-to-contribute)
* [Find an Issue](#find-an-issue)
Expand Down Expand Up @@ -43,11 +42,10 @@ We welcome many different types of contributions including:

Not everything happens through a GitHub pull request. Please come to our
[meetings](https://docs.google.com/document/d/1iFlVl7R97Lze4RDykzElJGDjjWYDlkI8Rhf8g4dQ5Rk/edit?usp=sharing) or [contact us](https://groups.google.com/g/wasmedge) and let's discuss how we can work
together.
together.

### Come to Meetings


Absolutely everyone is welcome to come to any of our meetings. You never need an
invite to join us. In fact, we want you to join us, even if you don’t have
anything you feel like you want to contribute. Just being there is enough!
Expand All @@ -66,7 +64,7 @@ suitable for someone who isn't a core maintainer and is good to move onto after
your first pull request.

Sometimes there won’t be any issues with these labels. That’s ok! There is
likely still something for you to work on. If you want to contribute but
likely still something for you to work on. If you want to contribute but
don’t know where to start or can't find a suitable issue, you can leave a comment under this issue like "I'd like to work on this. Can you tell XYZ (list the stuff you want to communicate)" or send your questions to our discord server or slack channel.

Once you see an issue that you'd like to work on, please post a comment saying
Expand All @@ -85,12 +83,11 @@ Before opening any issue, please look up the existing [issues](https://github.co

When reporting issues, always include:

- Version of your system
- Configuration files of WasmEdge
* Version of your system
* Configuration files of WasmEdge

Because the issues are open to the public, when submitting the log and configuration files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can replace those parts with "REDACTED" or other strings like "\*\*\*\*". Be sure to include the steps to reproduce the problem if applicable. It can help us understand and fix your issue faster.


## Pull Request Lifecycle

Pull requests are always welcome, even if they only contain minor fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it.
Expand All @@ -99,13 +96,13 @@ Please submit a pull request broken down into small changes bit by bit. A pull r

Generally, once your pull request has been opened, it will be assigned to one or more reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and coding style. If your PR is not ready to review, please mark your PR as a draft.

The reviewers will give you some feedback in three work days.
The reviewers will give you some feedback in three work days.

After the first review is done, the PR contributor is expected to review and make some changes based on the review in 5 workdays.
After the first review is done, the PR contributor is expected to review and make some changes based on the review in 5 workdays.

If you have finished the adjustments, mark the problem as solved, then the reviewers will review your PR again in 2 workdays.

If the PR contributor doesn't respond to the PR in 30 days, the maintainer will close the PR. The original PR contributor is welcome to open it again.
If the PR contributor doesn't respond to the PR in 30 days, the maintainer will close the PR. The original PR contributor is welcome to open it again.

If the PR contributor doesn't want to maintain the PR due to some reason, please enable maintainers to edit this PR if you still want this PR to be merged.

Expand All @@ -124,6 +121,7 @@ To build WasmEdge from the source, please refer to: [Build WasmEdge from source]
## Sign Your Commits

### DCO

Licensing is important to open source projects. It provides some assurances that
the software will continue to be available based under the terms that the
author(s) desired. We require that contributors sign off on commits submitted to
Expand All @@ -143,11 +141,10 @@ Git has a `-s` command line option to do this automatically:
git commit -s -m 'This is my commit message'

If you forgot to do this and have not yet pushed your changes to the remote
repository, you can amend your commit with the sign-off by running
repository, you can amend your commit with the sign-off by running

git commit --amend -s


## Pull Request Checklist

When you submit your pull request, or you push new commits to it, our automated
Expand All @@ -159,10 +156,8 @@ before you submit your code:
* DCO: Did you sign off your commit
* Code of conduct: Did you follow the CNCF code of conduct


## Reporting issues


## Documenting

Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.
Expand Down
5 changes: 3 additions & 2 deletions docs/contribute/source/build_from_src.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ Developers can set the CMake options to customize the WasmEdge building.
- To build the WASI-NN plug-in with multiple backends, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name1>,<backend_name2>`.
13. `WASMEDGE_PLUGIN_WASI_CRYPTO`: build the WasmEdge WASI-Crypto plug-in (Linux and MacOS platforms only). Default is `OFF`.
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
14. `WASMEDGE_PLUGIN_WASI_LOGGING`: build the WasmEdge WASI-Logging plug-in (Linux and MacOS platforms only). Default is `OFF`.
14. `WASMEDGE_PLUGIN_WASI_LOGGING`: build the WasmEdge WASI-Logging plug-in (Linux and MacOS platforms only). Default is `ON`.
- In WasmEdge `0.14.1`, the WASI-Logging plug-in is bundled into the WasmEdge library and will not generate the plug-in shared library target.
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
15. `WASMEDGE_PLUGIN_WASM_BPF`: build the WasmEdge wasm_bpf plugin (Linux platforms only). Default is `OFF`.
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
Expand All @@ -91,7 +92,7 @@ Developers can set the CMake options to customize the WasmEdge building.

Developers can follow the steps to build WasmEdge with plug-ins from source.

- [WASI-NN (OpenVINO, PyTorch, or TensorFlow-Lite backends)](plugin/wasi_nn.md)
- [WASI-NN (with several backends)](plugin/wasi_nn.md)
- [WASI-Crypto](plugin/wasi_crypto.md)
- [WasmEdge-Image](plugin/image.md)
- [WasmEdge-TensorFlow](plugin/tensorflow.md)
Expand Down
6 changes: 6 additions & 0 deletions docs/contribute/source/plugin/wasi_logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ sidebar_position: 1

WASI-Logging allows WebAssembly applications to log messages in a standardized way. This becomes particularly helpful when debugging applications or understanding the flow of execution within them. The WASI-Logging plug-in is designed to be straightforward to use, enabling developers to focus more on their application logic and less on logging mechanics.

<!-- prettier-ignore -->
:::note
In WasmEdge `0.14.1` version, this plug-in is bundled into the WasmEdge library and not generate the plug-in shared library.
The plug-in building architecture will be refactored in the future. Therefore we reserve this page for documentation before `0.14.0` versions.
:::

## Prerequisites

The prerequisite of the Wasi-Logging plug-in is the same as the WasmEdge building environment on the [Linux](../os/linux.md) and [MacOS](../os/macos.md) platforms.
Expand Down
Loading

0 comments on commit 6e63e2e

Please sign in to comment.