BlogPostsCell.js generated with the wrong Query
Closed this issue · 7 comments
This happens in the Cell section
I am surprised to still find value in repeating the whole Tutorial chapter (motive is really to develop the "muscle memory)
Hi @adriatic - are you meaning to indicate an error in the tutorial?
If so, we welcome pull requests!
Hi, Claire
This is not the first time to be reminded that you welcome PRs 😄 I think that I am a bit spoiled, having the belief that finding and reporting problems is already enough - but I often forget that Redwood is a tiny startup, where most of the work is done by volunteers. So, as I recalled that fact, the PR will soon follow.
Regards
Nik
Hi, Claire
This is not the first time to be reminded that you welcome PRs 😄 I think that I am a bit spoiled, having the belief that finding and reporting problems is already enough - but I often forget that Redwood is a tiny startup, where most of the work is done by volunteers. So, as I recalled that fact, the PR will soon follow.
Regards
Nik
PRs help convey the exact suggested change and make it simple to test and approve the suggestion if appropriate, making it more likely the change will be adopted.
Issues are another way of gathering community input, but for small changes like wording, it is almost always more efficient for both the requester and the maintainer to communicate via PRs.
For example, you have kindly taken the time to write this issue, yet it is not clear what change is being requested and where. A PR would clarify this in fewer words, and make it more likely the change is implemented as you expect. It's clear you have a passion for the tutorial - your zeal could make an impact as a contributor :)
My error was to assume the issues processing workflow like this: whoever looks at the bugs log, assigns the bug to the most expert person to handle the problem. In this specific case, the bug is in the tutorial, and Rob, who watches the tutorial like a hawk, will fix it himself
In my view, the tutorial is probably the most important part of RedwoodJS. This should not surprise you - I saw so many companies with brilliant software products and semi-OK documentation sinking like a stone. I tried hundreds and hundreds of interesting products and dismissed to look any deeper if based on a "quick start", or tutorial(s) I could not figure out what is going on here.
Let me use this PR case as a good example
You can see that I am reporting a run time error issued from an actor deep down in the stack (GraphQL). This is completely unacceptable for a released product as it indicates sloppiness. Such judgment does not apply to RedwoodJS, since it is not a released product; however unless someone as persistent as I am, continuously monitors the tutorial, it will not be error-free at the release time 😄
This is not a bug—the generator names the query the same as the cell, on purpose.
In this case, the name of the cell BlogPosts doesn't match the name of the model that's being queried (Post) and so in the next step of the tutorial we have you update that query with the proper name. This is on purpose because it could be a fairly common case, where your cell name doesn't match your model name and so we teach you right away the significance of that naming convention and how to change it.
... and that is precisely the reason for not creating a PR initially. I expected that you will warn me that my view is too narrow.
I made my judgment hastily, for not a good reason, creating a great impression of a dummy 😢. It was the error message from GraphQL that triggered my report creation. While I perfectly remembered that the blogPosts name would have to be renamed to posts, but seeing the error from GraphQL made me believe that something is different in this last release.
Repetitio est mater studiorum is the proverb I learned some 60 years ago, that works for my benefit here