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

SOLR-17583: Bring back documentation for Adding Custom Expressions #2903

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

cfeldmann
Copy link
Contributor

https://issues.apache.org/jira/browse/SOLR-17583

Description

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.

Solution

I found the source for the Custom Expressions section in the 8.7 docs and copied It to the current streaming-expressions.adoc page. The Expressible interface has been moved into the solrj-streaming package since version 8.7 so I updated the link to this interface to point to the correct javadoc location.

Tests

I ran ./gradlew tidy updateLicenses check -x test and then opened my local copy of the Reference Guide. I verified that I see the new text and that the link to the Expressible javadoc is working.

Checklist

Please review the following and check all that apply:

  • [x ] I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • [x ] I have created a Jira issue and added the issue ID to my pull request title.
  • [x ] I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
  • [x ] I have developed this patch against the main branch.
  • [x ] I have run ./gradlew check.
  • I have added tests for my changes.
  • [x ] I have added documentation for the Reference Guide

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 10, 2024
@mkhludnev
Copy link
Member

Thanks for PR. Have you tried to generate the doc? I'm not sure if the reference syntax hasn't changed from those times, and link might be broken.

@mkhludnev
Copy link
Member

Build it myself. Link to javadoc works fine. Merging. I don't think it deserves CHANGES row.

@mkhludnev mkhludnev merged commit 57eabb5 into apache:main Dec 11, 2024
3 checks passed
@mkhludnev
Copy link
Member

@cfeldmann please cherry-pick this commin to https://github.com/apache/solr/tree/branch_9x and make a PR.
Thanks!

@cfeldmann cfeldmann deleted the SOLR-17583 branch December 11, 2024 21:34
@janhoy
Copy link
Contributor

janhoy commented Dec 11, 2024

It can even be cherry picked to branch_9_7 for immediate visibility in the 9.7 guide.

@cfeldmann
Copy link
Contributor Author

cfeldmann commented Dec 11, 2024

Ok. I've opened PRs to cherry-pick this change to both branch_9x and branch_9_7:
#2904
#2905

cfeldmann added a commit to cfeldmann/solr that referenced this pull request Dec 11, 2024
…pache#2903)

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.

Co-authored-by: Christine Feldmann <[email protected]>
cfeldmann added a commit to cfeldmann/solr that referenced this pull request Dec 11, 2024
…pache#2903)

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.

Co-authored-by: Christine Feldmann <[email protected]>
janhoy pushed a commit that referenced this pull request Dec 12, 2024
…2903) (#2904)

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.

Co-authored-by: Christine Feldmann <[email protected]>
janhoy pushed a commit that referenced this pull request Dec 12, 2024
…2903) (#2905)

The section for adding Custom Expressions was removed in Solr 8.8. This change brings it back.

Co-authored-by: Christine Feldmann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants