Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@beertje44
Copy link
Contributor

@beertje44 beertje44 commented Jun 16, 2024

Description

Tutorial on using standard apache solr container with dovecot provided solr schema as dovecot fts backend in dms.

ref: #4025

Type of change

  • This change requires a documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary, I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added information about changes made in this PR to CHANGELOG.md

@casperklein
Copy link
Member

fts      --> FTS
imap     --> IMAP
dms      --> DMS
dovecot  --> Dovecot
solr     --> Solr 

Copy link
Member

@georglauterbach georglauterbach left a comment

Choose a reason for hiding this comment

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

After @casperklein's and my feedback has been addressed, you will still need to adjust the mkdocs.yml to integrate your new page into our documentation.

The PR itself is still in a rough shape; I will also request @polarathene for a final review, as he has the most experience with our docs. I don't want him to have a third look currently, though; having the last word and final review is appropriate IMO.

@georglauterbach georglauterbach added area/documentation kind/update Update an existing feature, configuration file or the documentation labels Jun 16, 2024
@georglauterbach
Copy link
Member

@polarathene go ahead and have a look :) I suggest you immediately apply feedback that you have 🚀


@beertje44 you can now already take a look at the preview we generate. Look out for comments from the github-actions bot, like this one.

@polarathene
Copy link
Member

Current preview of new docs page: https://pullrequest-4070--dms-doc-previews.netlify.app/examples/tutorials/dovecot-solr/

I have revised the PR a bit:

  • There was some parts from earlier review that had not been addressed (notably naming convention from @casperklein and new line requirements from @georglauterbach ) , additionally some typos to correct.
  • Other portions have been revised to be worded better, or restructured for better formatting for the reader to digest.
  • Relevant links added for context. Especially the UID/GID reference.

There is no mention for the dovecot-solr package requirement. My understanding is that we are not bringing that back as it's missing support for ARM64 releases?

I'll add a new commit to advise on including the package and ARM64 caveat, then this should be good for merging.

@polarathene polarathene added this to the v14.1.0 milestone Jun 18, 2024
@polarathene polarathene changed the title Dovecot fts solr tutorial docs: Add tutorial for configuring Dovecot FTS with Solr Jun 18, 2024
Copy link
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

I'll apply these.

@github-actions
Copy link
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 4260233

@polarathene polarathene enabled auto-merge (squash) June 18, 2024 03:31
@polarathene
Copy link
Member

Thanks everyone!

This guide seems to be missing some advice that was detailed by @erm967 in #4052 (comment) , is that not required for some reason?

I suspect that is one of the maintenance caveats to keep in mind as the external resource won't be tied to a specific DMS release (at least if this new doc page is not actively maintained across releases).


I've left the referenced feature request open, but I've also included a link on the new docs page for any interested users to express their interest in the package. I think we've covered why we no longer include the package and the workaround for Solr users is quite simple as covered in the docs.

Closing that feature request with this PR is acceptable. It can always be opened again in future if relevant.

@beertje44
Copy link
Contributor Author

Thanks everyone!

This guide seems to be missing some advice that was detailed by @erm967 in #4052 (comment) , is that not required for some reason?

I suspect that is one of the maintenance caveats to keep in mind as the external resource won't be tied to a specific DMS release (at least if this new doc page is not actively maintained across releases).

Simply including the right jars in a lib dir inside the solr core dir you have to create anyway is sufficient to make the dovecot schema work as is. Imho this is a better solution for most users then having to apply a patch that will change for every solr minor release. I've included a cp command in my tutorial.

@polarathene polarathene merged commit 40aab6b into docker-mailserver:master Jun 18, 2024
@georglauterbach georglauterbach modified the milestones: v14.1.0, v15.0.0 Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/update Update an existing feature, configuration file or the documentation service/dovecot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants