Docs update for Hacktoberfest #731
Conversation
maksim36ua
changed the title
There was a problem hiding this comment.
@maksim36ua nice job on this one, it looks very good! Left some comments, nothing major though. I approved up-front, so once you are done with taking care of comments you can merge if you wish, but if you wish me to take one more look before that, no problem, just ping me.
CONTRIBUTING.md
Outdated
|
|
||
| ## Tutorials or Example apps | ||
|
|
||
| Another great way to help is to create an app with Wasp! We have an [Examples](https://wasp-lang.dev/docs/examples) section on our website. As well as the [Tutorials](https://wasp-lang.dev/docs/pick-a-tutorial) page. Both those sections can be improved and updated with your projects. |
There was a problem hiding this comment.
Do we want people to merge their examples into our main repo?
Right now, examples we have are examples that we decided to put effort into maintaining and keeping up to date. If people added a number of their own examples, it would grow to an amount we can't support and maintain. Maybe we should rather encourage them to improve our example apps, and if they wish to show case their own example apps, they can add it to some kind of list that we could have somewhere -> I saw many projects having this, a list of projects using them, somewhere at the bottom of the README usually.
There was a problem hiding this comment.
The idea was to encourage people to build something with Wasp in the first place. And nothing can be more encouraging than being featured in the docs section of the tool you're using. I'd like to leave the possibility for people to create example apps. And we can decide later in what format it will be.
If the app is great -- it can be made into a tutorial. If it's not great but good enough -- we can ask a developer to commit to maintaining it. And if the dev won't be doing that -- we can remove it from examples list or figure out, whether someone else from the community would like to update it
There was a problem hiding this comment.
I am for it, I just wouldn't promise to make it part of our main repo (wasp-lang/wasp) because we already have too much work with maintaining the existing ones. So instead, best if they create them in their own repo -> but we can certainly feature them in our docs!
web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md
Outdated
Show resolved
Hide resolved
web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md
Outdated
Show resolved
Hide resolved
web/docs/tutorials/dev-excuses-app/perform-migration-and-run.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com>
Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com>
Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com>
Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com>
web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md
Outdated
Show resolved
Hide resolved
…into update-contribution-docs
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
…into update-contribution-docs
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
…into update-contribution-docs
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
…into update-contribution-docs
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
…into update-contribution-docs
web/docs/pick-a-tutorial.md
Outdated
|
|
||
| It's time to build something cool and check the capabilities of Wasp in action. Pick one of the app tutorials (there will be more of them with time) and leave us your impressions on <DiscordLink /> | ||
|
|
||
| The To-Do app is a relatively deep dive into many of Wasp's concepts. If you'd like to get familiar with Wasp on a more detailed level - please, pick this tutorial. Things like auth, dependency management, and operations - all be covered while you build a To-Do app. |
There was a problem hiding this comment.
Let's make this a link so people can just click on it here.
There was a problem hiding this comment.
It would also be cool if we could put a required amount of time to finish next to each tutorial (I think TODO should be about 30mins, but we can put 45 just to be safe)
There was a problem hiding this comment.
Changed the component to be a link. As for the time -- would be nice to make it a part of a UI, not just a piece of the text. It sounds like a simple good first issue, so I'll create one separately
|
|
||
| <img alt="Box of excuses for the win!" | ||
| src={useBaseUrl('img/accessible-website-excuse.jpg')} | ||
| /> |
There was a problem hiding this comment.
I would add some kind of "ending", like we have for todo app - basically explaining where to go next, you could mention that there is a todo app tutorial which covers more advanced stuff like auth and etc, and that they can go check it out on this link etc.
Co-authored-by: Matija Sosic <matija.sosic@gmail.com>
…into update-contribution-docs
* Added 'How Wasp got to 1k stars on gh' blog post. * Docs update for Hacktoberfest (#731) * Initial docs update for Hacktoberfest * Contributing.md update * Update "Before you begin" section * Update web/docs/tutorials/dev-excuses-app/creating-the-project.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> * Update web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> * Update web/docs/tutorials/dev-excuses-app/modifying-main-wasp-file.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> * Update the section names * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/contributing.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/contributing.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/contributing.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Add Discord component and some minor fixes * Add unclear notice * Update web/docs/pick-a-tutorial.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app/modifying-main-wasp-file.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/getting-started.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app/modifying-main-wasp-file.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Review updates * Update web/docs/tutorials/dev-excuses-app/modifying-main-wasp-file.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update suggestion * Update web/docs/tutorials/dev-excuses-app/perform-migration-and-run.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update web/docs/tutorials/dev-excuses-app/perform-migration-and-run.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update * Update web/docs/tutorials/dev-excuses-app/updating-main-page-js-file.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Remove lines * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update getExcuse function * Update page naming convention * Remove Main.css * Update migration text * Update image * Update "Wasp's compiler is built with Haskell" * Add tutorials description * Update web/docs/pick-a-tutorial.md Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update Discord link and tutorial ending * Update links Co-authored-by: mkhamrov <mkhamrov@redhat.com> Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> Co-authored-by: Matija Sosic <matija.sosic@gmail.com> * Update to-do app tutorial links * Fixed a bit 'how to get started with haskell in 2022' blog post. * Small fix of 'Pick a Tutorial' doc page. (#737) * Linked Copilot post to its HN discussion. * Added Farnance showcase blog post. * Improved messaging about node version in getting started page in docs. * Added Beta announcement bar to the landing page and docs. * Update Docusaurus (#797) * Adds Fly.io to deployment guide (#803) Co-authored-by: Matija Sosic <matija.sosic@gmail.com> Co-authored-by: vincanger <70215737+vincanger@users.noreply.github.com> * Added Alpha Testing Program: post-mortem blog post. * Update features.md newUser snippets more explicit examples * add railway deployment (#818) * Added Hacktoberfest 2022 reflections blog post. * update Railway client deployment * add railway proxy warning * Update image thumbnail (#832) Co-authored-by: mkhamrov <mkhamrov@redhat.com> * Added Beta Launch Week announcement post. * small blog fix, updated thumbnail img. * Added Michael Curry (cursorial) use case blog post. * Added Erlis Kllogjri's Amicus use case blog post. * Fixed some grammar errors in use case posts. * first pass at both beta launch blog posts * minor edits * clean up Features, GoogleAuth, & Deploy docs (#820) * add railway deployment * clean up Features and GoogleAuth docs * Update web/docs/language/features.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> Co-authored-by: Martin Sosic <sosic.martin@gmail.com> * Created new landing page for Beta. Co-authored-by: Matija Sosic <matija.sosic@gmail.com> Co-authored-by: Max Khamrovskyi <maksim36ua@gmail.com> Co-authored-by: mkhamrov <mkhamrov@redhat.com> Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> Co-authored-by: Martin Sosic <sosic.martin@gmail.com> Co-authored-by: Shayne Czyzewski <523636+shayneczyzewski@users.noreply.github.com> Co-authored-by: vincanger <70215737+vincanger@users.noreply.github.com> Co-authored-by: shayneczyzewski <shayne.czyzewski@gmail.com>
Description
Docs update with contribution guidelines and dev excuses app tutorial.