Remove `search_fields` definitions from tutorial code
gasman opened this issue · comments
Pertinent section of the Wagtail docs
https://docs.wagtail.org/en/stable/getting_started/tutorial.html
Details
The BlogPage
model in the code snippets includes a search_fields
definition. This is never explained in the text, serves no purpose within the tutorial (since the created site does not have a search feature), and is a potential cause of user error (see #11562). I propose removing this from the code examples, in the interests of keeping the tutorial simple and focused.
Working on this
This is only a suggestion at this point - I would advise waiting until this has been accepted by the core team before proceeding with this.
Anyone can contribute to this. View our contributing guidelines, add a comment to the issue once you’re ready to start.
Hi @gasman,
I would like to solve this issue
Discussed in the core team meeting today. We're happy for this to go ahead, but @thibaudcolas pointed out that the extended tutorial introduced in Wagtail 6.0 does cover search, so this part will need to be updated to introduce the search_fields
definitions.
@nikhilkalburgi Thanks - you're welcome to pick this up.