Add tutorial about Single Page Application#1514
Add tutorial about Single Page Application#1514codec-abc wants to merge 14 commits intoyewstack:masterfrom
Conversation
|
Thanks for adding this! I think it's not a bad move adding a tutorial to the documentation. Questions that come to mind to me about this are:
My thoughts on the first question are that we don't want an "official" tutorial, but including a few community contributed tutorials in the documentation seems like a solid plan. In terms of maintance perhaps we should have a maintanance structure similar to Yewtil – i.e. that bugfixes/improvements are accepted but the core project maintainers don't commit to maintaining it? |
|
@teymour-aldridge: |
teymour-aldridge
left a comment
There was a problem hiding this comment.
There's quite a bit here! This is just an initial pass to fix some spelling grammar.
My fear is that some of the code is going to fall behind/get confused as it is updated and it may be a struggle to keep it compiling and running as intended, particularly because it's written up as a series of diffs so at each stage the code needs to work and we can't set up some sort of CI for the progress as far as I can see.
I realise that you didn't write the original tutorial so it might be difficult to address some of these issues.
I'm pretty convinced that this should either be an unoffical tutorial included in the documentation, or set up somewhere externally and then linked to by us.
| original_id: single-page-application | ||
| --- | ||
|
|
||
| This tutorial is based on an tutorial by [Sheshbabu](https://github.com/sheshbabu). The original article can be found [here.](http://www.sheshbabu.com/posts/rust-wasm-yew-single-page-application/). It has been slightly reworked and should give a pretty good understanding of Yew and how to build single pages Application. Still, if you see a way in which it can improve this tutorial to do reach the Yew community. Contributions are welcome. |
There was a problem hiding this comment.
an tutorial => a tutorial
single pages Application => single page applications
I'm not 100% sure about what the meaning of "Still, if you see a way in which it can improve this tutorial to do reach the Yew community." is
| This tutorial is based on an tutorial by [Sheshbabu](https://github.com/sheshbabu). The original article can be found [here.](http://www.sheshbabu.com/posts/rust-wasm-yew-single-page-application/). It has been slightly reworked and should give a pretty good understanding of Yew and how to build single pages Application. Still, if you see a way in which it can improve this tutorial to do reach the Yew community. Contributions are welcome. | |
| This tutorial is based on a tutorial by [Sheshbabu](https://github.com/sheshbabu). The original article can be found [here.](http://www.sheshbabu.com/posts/rust-wasm-yew-single-page-application/). It has been slightly reworked and should give a pretty good understanding of Yew and how to build single page applications. Still, if you see a way in which it can improve this tutorial to do reach the Yew community. Contributions are welcome. | |
There was a problem hiding this comment.
It just a way to encourage people to do a PR to improve the tutorial if they see a way to do so. How you would phrase it?
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
| wasm-bindgen = "0.2" | ||
| ``` | ||
|
|
||
| Now, we will create a new file named `Makefile.toml` to automate our build. We will use the following content: |
There was a problem hiding this comment.
Maybe this needs some explanation (that it uses a tool called cargo-make) – just something brief?
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-0.17.3/getting-started/tutorials/single-page-application.md
Outdated
Show resolved
Hide resolved
|
Also it looks to me like the spellcheck hasn't fired? |
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
|
What do you mean by spellcheck firing? Is there something in particular that should run spellcheck on this? Or maybe you mean using something like Word on the text? |
…s/single-page-application.md Co-authored-by: Teymour Aldridge <[email protected]>
|
We have a Github action which checks all the spellings, but it seems not to have run on this PR for some reason. |
|
This has been sitting for a while – I think it would be better hosted externally and then linked to as a "community resource" in the documentation
Perhaps we should add a note stating that people writing code for Yew might find it useful to ask on the Discord server if they get stuck? |
|
So where to find this tutorial after all the above, so that it stays current? |
|
Not sure. @sheshbabu might be happy to have a look and update the blog post where they think would be appropriate to do so and we can add a link to their tutorial under a "community resources" section? |
|
#1968 added the tutorial so we can now close this PR |
Description
As discussed in the issue #1384 and the Discord server this PR add a tutorials section and specifically the tutorial @sheshbabu has written in his blog.
Fixes # (issue) 1384
On the technical side I struggled to add the page to the website. Specifically, I needed to add the page and the entry for the sidebar in the 0.17.3 version so it shows up when running docusaurus. I'm not sure if it's in the correct directory. I would appreciate feedback about this.
Checklist:
./ci/run_stable_checks.sh