-
Notifications
You must be signed in to change notification settings - Fork 556
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
[EN] add WebAssembly #2117
[EN] add WebAssembly #2117
Conversation
Signed-off-by: Arun Karthick N M <[email protected]>
✅ Deploy Preview for cncfglossary ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Is it fine? @iamNoah1 |
Thanks for your contribution, @arunkarthicknm. We are currently working our way through our backlog. This is on our to-do list, but there are a few terms that need to be reviewed before yours. Thanks for your patience! |
Sure @CathPag |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @arunkarthicknm
Thank you for the contribution. Before reviewers start to review its content, please check the following comments. :)
Co-authored-by: Seokho Son <[email protected]> Signed-off-by: Catherine Paganini <[email protected]>
Co-authored-by: Seokho Son <[email protected]> Signed-off-by: Catherine Paganini <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @arunkarthicknm, some thoughts:
content/en/webassembly.md
Outdated
## What it is | ||
|
||
WebAssembly (often abbreviated as Wasm) is a binary instruction format designed as a portable target for compiling high-level languages like C, C++, Rust, and others, enabling deployment on the web for client-side and server-side applications. | ||
It is a low-level bytecode format that can be executed in a virtual machine, typically integrated into web browsers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may be good to mention that Wasm is not just for web applications—it's useful in other spaces too, like IoT, Edge, Cloud, etc. It's a universal runtime, and could probably be used on any platform.
I'd also suggest linking to the virtual machine definition page.
content/en/webassembly.md
Outdated
## Problem it addresses | ||
Traditional web applications are primarily built using JavaScript, which is an interpreted language. | ||
While JavaScript has improved over the years, it still faces performance limitations when executing computationally intensive tasks. | ||
With JavaScript, developers often need to rewrite their code to make it work across different platforms and environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section focuses a lot on JavaScript, and brings up valid issues, but Wasm is something that works along side it, not necessarily replacing it (and it's not that JavaScript needs to be rewritten, I think it's more that the browser environment is inconsistent). I tend to think of Wasm for performance centric stuff, and JavaScript for more dynamic tasks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder about the rewriting bit here -- thinking more on it, one of the things that WASM helps with is not having to rewrite legacy code either -- if you have some old C code that is doing the job, it can potentially be used without rewriting on the web now too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I question the accuracy in comparing WASM to javascript at all. I would also remove this.
This opens up new possibilities and allows developers to reuse existing codebases and libraries. | ||
Also, WebAssembly modules can run consistently across different browsers, operating systems, and devices, reducing the need for platform-specific code. | ||
|
||
Overall, WebAssembly addresses performance limitations, language restrictions, code portability, security concerns, code size, and loading time issues, providing a more robust and flexible environment for web application development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we mention security here, it might be worth noting that WebAssembly has a sandboxed execution environment, meaning it isolates the WebAssembly program from the system it's running on, which can provide some protection against malicious code. This may not be the best place to bring it up since it's the concluding paragraph though.
Hi @arunkarthicknm, it's been a couple of weeks since we've seen any activity on this PR, and I wanted to check-in. Please don't hesitate to ask if you have any questions or need further clarification on any of the points I've raised. We're here to help. |
Agreed with @nate-double-u on the suggested changes. If no objections I'll noodle on some recommended wording for the content. |
No objections, please noodle 🙂 |
What is the status here? @nate-double-u |
@hlipsig, you were working on a review, but had some questions around how best to provide the feedback. Did we land on a best practice? |
@nate-double-u @hlipsig my suggestion would be to add suggestions via the suggestion feature so that they can easily be added (committed) through the web ui. And also as the author is not responsive anymore we should just go on and make the suggested changes ourselves. What you think @nate-double-u, wanna take over? Or @arunkarthicknm wants to follow up? |
I'm happy to take it over. @hlipsig, I'm also happy to work with you to get your suggestions in, I'd hate for you to have done work that didn't get considered 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't get my thoughts on security together, but here was my first pass at improvements.
content/en/webassembly.md
Outdated
## Problem it addresses | ||
Traditional web applications are primarily built using JavaScript, which is an interpreted language. | ||
While JavaScript has improved over the years, it still faces performance limitations when executing computationally intensive tasks. | ||
With JavaScript, developers often need to rewrite their code to make it work across different platforms and environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I question the accuracy in comparing WASM to javascript at all. I would also remove this.
Co-authored-by: Hilliary Lipsig <[email protected]> Signed-off-by: Noah Ispas <[email protected]>
Co-authored-by: Hilliary Lipsig <[email protected]> Signed-off-by: Noah Ispas <[email protected]>
Co-authored-by: Hilliary Lipsig <[email protected]> Signed-off-by: Noah Ispas <[email protected]>
Signed-off-by: Nate W <[email protected]>
Signed-off-by: Nate W <[email protected]>
Signed-off-by: Nate W <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Thanks for your patience @arunkarthicknm, and to all the reviewers!
To see where this is in the review pipeline and follow the progress, please look at the definition review board. |
1 similar comment
To see where this is in the review pipeline and follow the progress, please look at the definition review board. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
content/en/webassembly.md
Outdated
@@ -0,0 +1,23 @@ | |||
--- | |||
title: WebAssembly | |||
status: Feedback Appreciated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
status: Feedback Appreciated | |
status: Completed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this great work! Let me update the tag to make the term live.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed-off-by: Seokho Son <[email protected]>
This resolves #1942
Checklist before opening this PR (put
x
in the checkboxes)git commit -s
) is to affirm that commits comply DCO. If you are working locally, you could add an alias to yourgitconfig
by runninggit config --global alias.ci "commit -s"
.