10000 docs: add documentation for search by filipweidemann · Pull Request #7972 · django-cms/django-cms · GitHub
[go: up one dir, main page]

Skip to content

docs: add documentation for search #7972

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

Merged
merged 5 commits into from
Jul 31, 2024
Merged

docs: add documentation for search #7972

merged 5 commits into from
Jul 31, 2024

Conversation

filipweidemann
Copy link
Contributor
@filipweidemann filipweidemann commented Jul 29, 2024

Description

Add documentation on how to setup basic search indexes using django-haystack.
Also reference extensions that do most of the work without needing to reinvent it per code base.

It is a docs-only PR, so no changed tests.

This PR resolves #7571

Related resources

Checklist

  • I have opened this pull request against develop-4
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

@filipweidemann filipweidemann changed the title Add documentation for search docs: add documentation for search Jul 29, 2024
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello! Thank you for your contribution! 🎉

As it's your first contribution, be sure to check out the contribution docs.

We invite you to join us on our Discord Server!

Welcome aboard ⛵️!

Copy link
Member
@fsbraun fsbraun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @filipweidemann !

This sounds great to me and is an excellent extension for the docs! I only have one comment to it: We should not rely on the details of the djangocms-versioning implementation.

@marksweb Any thoughts?

@filipweidemann
Copy link
Contributor Author

The codespell job was failing, I pushed a new commit to correct the spelling error. Should be good now if y'all are happy with it as well :)

@fsbraun fsbraun merged commit 40b0c9f into django-cms:develop-4 Jul 31, 2024
32 checks passed
@fsbraun
Copy link
Member
fsbraun 86E5 commented Sep 3, 2024

The djangocms-haystack package also provides a search index for django-haystack for django CMS >= 4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] The suggested aldryn-search package does not work anymore with django>=4
2 participants
0