Skip to content
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

Added docs on searching #301

Merged
merged 4 commits into from
Nov 29, 2022
Merged

Conversation

nikcio
Copy link
Contributor

@nikcio nikcio commented Oct 13, 2022

Adds to #190

Updated code examples and added some more information by looking trough the code and referencing this page: https://lucene.apache.org/core/4_8_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description

This also adds more information to the XML on .Fuzzy().

Copy link
Owner

@Shazwazza Shazwazza left a comment

Choose a reason for hiding this comment

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

This is fantastic :) left a couple of comments

@nikcio
Copy link
Contributor Author

nikcio commented Oct 17, 2022

I've updated the text like so to reflect the feedback: 0430583

Copy link
Owner

@Shazwazza Shazwazza left a comment

Choose a reason for hiding this comment

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

Thanks again, have added another comment. One more thing though - just to confuse you some more 😅 - the docs are built from the master branch so if you can rebase to master that would be awesome. Else I can always squash commit this and cherry pick it.

@nikcio
Copy link
Contributor Author

nikcio commented Oct 21, 2022

Thanks again, have added another comment. One more thing though - just to confuse you some more 😅 - the docs are built from the master branch so if you can rebase to master that would be awesome. Else I can always squash commit this and cherry pick it.

I think it would be best to squash the commits and cherry pick it then both branches will have the up to date documentation and it won't confuse anyone else why there's two different versions of the documentation😄. (And I won't confuse myself 😅 ).

Anyways wouldn't it be easier to build the documentation from the current default branch and just have the default branch be the newest version of Examine?

I can see that you already use release/<Version> for releases then shouldn't those branches just be used for further development also?

  • release/2.0 For further v2 development
  • release/3.0 For further v3 development

I also see that you have some vX.X branches and maybe those are meant to be for that?

For example:

  • v1.0
  • v1.0.6
  • v2.0
  • v2.0-lucene3

Another way I've been having great success with is using the same scheme as Umbraco:

  • contrib/v1 For version 1
  • contrib/v2 For version 2
  • contrib/v3 For version 3
  • And so on

Then it's clear to see which branch is the newest version of what major release and you just have to make a new branch and make it default when a new major is needed. And if a developer needs to look at a specific version like v1.0.6 then they can use the tags added on releases.

Essentially I'm saying that the current master and dev branch is a bit confusing when coming from outside the project 😄

@Shazwazza Shazwazza added the hacktoberfest-accepted Part Hacktoberfest label Oct 28, 2022
@Shazwazza Shazwazza merged commit 64d2b1b into Shazwazza:release/3.0 Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Part Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants