Skip to content
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

[Feat] - Add Contributors Page, Updated Docusaurus, Fix Linters #175

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,22 @@ jobs:
- name: Lint
run: npm run lint:ci

# - name: Prettier Code
# run: npm run format:diff
lint-md:
name: Markdown Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v37
id: changed-files
with:
files: '**/*.md'
separator: ","
- uses: DavidAnson/markdownlint-cli2-action@v11
if: steps.changed-files.outputs.any_changed == 'true'
with:
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","
config: '.github/linters/.markdown-lint.yml'

2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

FORCE_COLOR=1 npm run lint-staged --allow-empty
FORCE_COLOR=1 npm run lint-staged --allow-empty && npm run lint:md-fix
8 changes: 8 additions & 0 deletions docs/contribute/community/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "WasmEdge Users and Contributors",
"position": 11,
"link": {
"type": "generated-index",
"description": "We appreciate our users and fellow community members' contributions"
}
}
25 changes: 25 additions & 0 deletions docs/contribute/community/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 2
---

# WasmEdge Contributors

We want to extend our deepest gratitude to each and every one of you who have contributed to this open-source project. Your hard work, dedication, and passion for coding have not only made this project possible but have also enriched the broader open-source community.

## Your Impact

- **Code Contributions**: Whether you've submitted a single line of code or have been a long-term contributor, your work has made a difference.
- **Documentation**: Thanks to those who have improved or even just corrected a typo in the documentation. Every bit helps!
- **Bug Reports**: Identifying issues is just as important as fixing them. Thank you for taking the time to report bugs.
- **Feature Requests**: Your innovative ideas have been invaluable in driving the project forward.
- **Community Support**: Those who have helped by answering questions, providing support, and moderating discussions, you've created a welcoming community for everyone.

| Name | Role | Organization | LinkedIn | Twitter | GitHub |
Copy link
Collaborator

Choose a reason for hiding this comment

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

If you can't list all the maintainers, then it's meaningless.

Copy link
Contributor Author

@adithyaakrishna adithyaakrishna Oct 17, 2023

Choose a reason for hiding this comment

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

@alabulei1 Its a WIP, I dont have the info regarding the Role Organization and the social media links. Could you please share with me the same?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't have this information either.

|----------------|----------|--------------|----------|----------|----------|
| Vivian Hu | Data 2A | Data 3A | Data 4A | Data 5A | Data 5A |
| Michael Yuan | Data 2A | Data 3A | Data 4A | Data 5A | Data 5A |


## Looking Forward

We're excited about the future of this project, and we can't wait to see where your contributions take us next. Here's to many more years of collaboration, innovation, and open-source goodness!
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 1
---

# WasmEdge Users and Collaborators
Expand Down
24 changes: 19 additions & 5 deletions docs/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest

When ready for review, push your branch to your fork repository on github.

Then visit your fork at <https://github.com/$user/WasmEdge> and click the `Compare & Pull Request` button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes.
Then visit your fork at <https://github.com/$user/WasmEdge> and click the `Compare & Pull Request` button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference issues (using keywords such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes.

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.

Expand All @@ -71,10 +71,24 @@ Because the issues are open to the public, when submitting the log and configura

## 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.
Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. Our docs reside at this [repository](https://github.com/WasmEdge/docs/)

## Design new features
See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.

You can propose new designs for existing WasmEdge features. You can also design new features; please submit a proposal via the GitHub issues.
## Feature Requests

- **Suggesting Enhancements**: If you have ideas for improving existing features in WasmEdge, we welcome your input.
- **Introducing New Features**: You're also encouraged to propose completely new functionalities that could benefit the project.
- **How to Submit**: To formalize your suggestions, please submit a feature request proposal through [GitHub Issues](https://github.com/WasmEdge/docs/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.yml&title=Feature+Request%3A+).

### Review Process

- **Timely Evaluation**: Our team of WasmEdge maintainers will review your proposal as quickly as possible.
- **Architectural Consistency**: We aim to ensure that all contributions align well with the existing architecture of WasmEdge.
- **Avoiding Redundancy**: Part of the review process includes checking the project's roadmap to avoid duplicated efforts.

### Communication

- **Feedback Loop**: After the initial review, we may ask for further clarifications or suggest modifications to align with the project's goals.
- **Status Updates**: We aim to keep you informed about the status of your proposal throughout the review process.

WasmEdge maintainers will review this proposal as soon as possible to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap.
5 changes: 4 additions & 1 deletion docs/embed/go/reference/0.9.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,10 @@ Run bindgen -- keccak_digest: [126 194 241 200 151 116 227 33 216 99 159 22 107

### Example of Embedding A Full WASI Program

Note: You can use the latest Rust compiler to create a standalone WasmEdge application with a `main.rs` functions and then embed it into a Golang application.
<!-- prettier-ignore -->
:::note
You can use the latest Rust compiler to create a standalone WasmEdge application with a `main.rs` functions and then embed it into a Golang application.
:::

Besides functions, the WasmEdge Golang SDK can also [embed standalone WebAssembly applications](https://github.com/second-state/WasmEdge-go-examples/tree/master/go_ReadFile) — i.e. a Rust application with a `main()` function compiled into WebAssembly.

Expand Down
7 changes: 6 additions & 1 deletion docs/start/usage/serverless/vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,12 @@ That's it. [Deploy the repo to Vercel](https://vercel.com/docs/git#deploying-a-g

The [second demo](https://vercel-wasm-runtime.vercel.app/) application allows users to upload an image and then invoke a serverless function to classify the main subject on the image.

It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch. Note: when you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch.

<!-- prettier-ignore -->
:::note
When you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
:::

The backend serverless function for image classification is in the [`api/functions/image-classification`](https://github.com/second-state/vercel-wasm-runtime/tree/tensorflow/api/functions/image-classification) folder in the `tensorflow` branch. The [`src/main.rs`](https://github.com/second-state/vercel-wasm-runtime/blob/tensorflow/api/functions/image-classification/src/main.rs) file contains the Rust program’s source code. The Rust program reads image data from the `STDIN`, and then outputs the text output to the `STDOUT`. It utilizes the WasmEdge Tensorflow API to run the AI inference.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "WasmEdge Users and Contributors",
"position": 11,
"link": {
"type": "generated-index",
"description": "We appreciate our users and fellow community members' contributions"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 2
---

# WasmEdge Contributors

We want to extend our deepest gratitude to each and every one of you who have contributed to this open-source project. Your hard work, dedication, and passion for coding have not only made this project possible but have also enriched the broader open-source community.

## Your Impact

- **Code Contributions**: Whether you've submitted a single line of code or have been a long-term contributor, your work has made a difference.
- **Documentation**: Thanks to those who have improved or even just corrected a typo in the documentation. Every bit helps!
- **Bug Reports**: Identifying issues is just as important as fixing them. Thank you for taking the time to report bugs.
- **Feature Requests**: Your innovative ideas have been invaluable in driving the project forward.
- **Community Support**: Those who have helped by answering questions, providing support, and moderating discussions, you've created a welcoming community for everyone.

| Name | Role | Organization | LinkedIn | Twitter | GitHub |
|----------------|----------|--------------|----------|----------|----------|
| Vivian Hu | Data 2A | Data 3A | Data 4A | Data 5A | Data 5A |
| Michael Yuan | Data 2A | Data 3A | Data 4A | Data 5A | Data 5A |


## Looking Forward

We're excited about the future of this project, and we can't wait to see where your contributions take us next. Here's to many more years of collaboration, innovation, and open-source goodness!
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 1
---

# WasmEdge Users and Collaborators
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,12 @@ That's it. [Deploy the repo to Vercel](https://vercel.com/docs/git#deploying-a-g

The [second demo](https://vercel-wasm-runtime.vercel.app/) application allows users to upload an image and then invoke a serverless function to classify the main subject on the image.

It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch. Note: when you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
It is in [the same GitHub repo](https://github.com/second-state/vercel-wasm-runtime) as the previous example but in the `tensorflow` branch.

<!-- prettier-ignore -->
:::note
When you [import this GitHub repo](https://vercel.com/docs/git#deploying-a-git-repository) on the Vercel website, it will create a [preview URL](https://vercel.com/docs/platform/deployments#preview) for each branch. The `tensorflow` branch would have its own deployment URL.
:::

The backend serverless function for image classification is in the [`api/functions/image-classification`](https://github.com/second-state/vercel-wasm-runtime/tree/tensorflow/api/functions/image-classification) folder in the `tensorflow` branch. The [`src/main.rs`](https://github.com/second-state/vercel-wasm-runtime/blob/tensorflow/api/functions/image-classification/src/main.rs) file contains the Rust program’s source code. The Rust program reads image data from the `STDIN`, and then outputs the text output to the `STDOUT`. It utilizes the WasmEdge Tensorflow API to run the AI inference.

Expand Down
Loading