Skip to content

Commit 959bdde

Browse files
committed
Update docs for 0.14.1 and plug-in information.
Signed-off-by: YiYing He <yiying@secondstate.io>
1 parent 0ed52dd commit 959bdde

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+891
-703
lines changed

.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
WASMEDGE_VERSION='0.14.0'
1+
WASMEDGE_VERSION='0.14.1'
22
WASMEDGE_GO_VERSION='0.13.4'

docs/contribute/contribute.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ sidebar_position: 8
44

55
# Contributing Guide
66

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

4443
Not everything happens through a GitHub pull request. Please come to our
4544
[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
46-
together.
45+
together.
4746

4847
### Come to Meetings
4948

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

6866
Sometimes there won’t be any issues with these labels. That’s ok! There is
69-
likely still something for you to work on. If you want to contribute but
67+
likely still something for you to work on. If you want to contribute but
7068
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.
7169

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

8684
When reporting issues, always include:
8785

88-
- Version of your system
89-
- Configuration files of WasmEdge
86+
* Version of your system
87+
* Configuration files of WasmEdge
9088

9189
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.
9290

93-
9491
## Pull Request Lifecycle
9592

9693
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.
@@ -99,13 +96,13 @@ Please submit a pull request broken down into small changes bit by bit. A pull r
9996

10097
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.
10198

102-
The reviewers will give you some feedback in three work days.
99+
The reviewers will give you some feedback in three work days.
103100

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

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

108-
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.
105+
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.
109106

110107
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.
111108

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

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

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

148146
git commit --amend -s
149147

150-
151148
## Pull Request Checklist
152149

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

162-
163159
## Reporting issues
164160

165-
166161
## Documenting
167162

168163
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.

docs/contribute/source/build_from_src.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ Developers can set the CMake options to customize the WasmEdge building.
7676
- To build the WASI-NN plug-in with multiple backends, please use `-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=<backend_name1>,<backend_name2>`.
7777
13. `WASMEDGE_PLUGIN_WASI_CRYPTO`: build the WasmEdge WASI-Crypto plug-in (Linux and MacOS platforms only). Default is `OFF`.
7878
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
79-
14. `WASMEDGE_PLUGIN_WASI_LOGGING`: build the WasmEdge WASI-Logging plug-in (Linux and MacOS platforms only). Default is `OFF`.
79+
14. `WASMEDGE_PLUGIN_WASI_LOGGING`: build the WasmEdge WASI-Logging plug-in (Linux and MacOS platforms only). Default is `ON`.
80+
- 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.
8081
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
8182
15. `WASMEDGE_PLUGIN_WASM_BPF`: build the WasmEdge wasm_bpf plugin (Linux platforms only). Default is `OFF`.
8283
- This option is useless if the option `WASMEDGE_BUILD_PLUGINS` is set as `OFF`.
@@ -91,7 +92,7 @@ Developers can set the CMake options to customize the WasmEdge building.
9192

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

94-
- [WASI-NN (OpenVINO, PyTorch, or TensorFlow-Lite backends)](plugin/wasi_nn.md)
95+
- [WASI-NN (with several backends)](plugin/wasi_nn.md)
9596
- [WASI-Crypto](plugin/wasi_crypto.md)
9697
- [WasmEdge-Image](plugin/image.md)
9798
- [WasmEdge-TensorFlow](plugin/tensorflow.md)

docs/contribute/source/plugin/wasi_logging.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ sidebar_position: 1
66

77
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.
88

9+
<!-- prettier-ignore -->
10+
:::note
11+
In WasmEdge `0.14.1` version, this plug-in is bundled into the WasmEdge library and not generate the plug-in shared library.
12+
The plug-in building architecture will be refactored in the future. Therefore we reserve this page for documentation before `0.14.0` versions.
13+
:::
14+
915
## Prerequisites
1016

1117
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.

0 commit comments

Comments
 (0)