Skip to content

Conversation

nicpenning
Copy link
Contributor

@nicpenning nicpenning commented Aug 31, 2025

Might fix #133891 ?

@elasticsearchmachine elasticsearchmachine added v9.2.0 needs:triage Requires assignment of a team area label external-contributor Pull request authored by a developer outside the Elasticsearch team labels Aug 31, 2025
@nik9000 nik9000 added the :Analytics/ES|QL AKA ESQL label Sep 3, 2025
@elasticsearchmachine elasticsearchmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Sep 3, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Sep 3, 2025
@nik9000 nik9000 self-assigned this Sep 3, 2025
@nik9000 nik9000 self-requested a review September 3, 2025 20:59
@nik9000
Copy link
Member

nik9000 commented Sep 3, 2025

This is almost the right place. We generate these docs by running our tests. So running the tests will undo this. If you do this:

--- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/regex/RLike.java
+++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/regex/RLike.java
@@ -32,7 +32,7 @@ public class RLike extends RegexMatch<RLikePattern> {
     public static final String NAME = "RLIKE";
 
     @FunctionInfo(returnType = "boolean", description = """
-        Use `RLIKE` to filter data based on string patterns using using
+        Use `RLIKE` to filter data based on string patterns using
         <<regexp-syntax,regular expressions>>. `RLIKE` usually acts on a field placed on

Then run:

./gradlew :x-pack:plugin:esql:test -Dtests.class='*RLikeTests'

That'll regenerate all those md and json files we pass around. It needs to run the tests, but should be fine. A lot of the docs generation stuff is linked into the tests because we generate tables and stuff from the test inputs.

Would you like to make those changes on this PR? I'd be happy to merge it.

@nik9000
Copy link
Member

nik9000 commented Sep 3, 2025

The story is that both kibana and the docs build need stuff about esql function. And the place with the most comprehensive list of supported parameter combinations is our docs. So we had the tests generate the json and markdown files kibana and the docs need. It's a bit of a pain to rerun the tests but it's a lot less painful than hand maintaining a bunch of files. We commit the generated markdown and json files because the docs build and kibana build don't know anything about how to run Elaticsearch's build. It's certainly not ideal that these can get out of date. But it's the compromise we chose to keep the docs and kibana builds simpler.

@nicpenning
Copy link
Contributor Author

Please go ahead and resolve as you see fit. I appreciate the back end info as I may give another run at this another time. If this is in the contributor docs somewhere and I missed it, please send me a link! If not, no worries I will use these methods next time.

@nik9000 nik9000 added the >docs General docs changes label Sep 4, 2025
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Sep 4, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/core-docs (Team:Docs)

@nik9000
Copy link
Member

nik9000 commented Sep 4, 2025

Looks like I was wrong. This bit isn't generated. But other bits are. I'll catch the other bits up in a follow up change and merge this.

@nik9000 nik9000 enabled auto-merge (squash) September 4, 2025 13:42
Copy link
Contributor

github-actions bot commented Sep 4, 2025

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

nik9000 added a commit to nik9000/elasticsearch that referenced this pull request Sep 4, 2025
`using using` isn't right.

Relates to elastic#133892
@nik9000 nik9000 mentioned this pull request Sep 4, 2025
@nik9000
Copy link
Member

nik9000 commented Sep 4, 2025

I opened #134138 to cover the other bits.

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

@nik9000 nik9000 disabled auto-merge September 8, 2025 18:09
@nik9000 nik9000 merged commit da50c72 into elastic:main Sep 8, 2025
8 checks passed
@nik9000
Copy link
Member

nik9000 commented Sep 8, 2025

Thanks again @nicpenning .

nik9000 added a commit that referenced this pull request Sep 8, 2025
`using using` isn't right.

Relates to #133892
@nicpenning
Copy link
Contributor Author

No problem! Happy to help (or try to :)).

rjernst pushed a commit to rjernst/elasticsearch that referenced this pull request Sep 9, 2025
rjernst pushed a commit to rjernst/elasticsearch that referenced this pull request Sep 9, 2025
`using using` isn't right.

Relates to elastic#133892
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Analytics/ES|QL AKA ESQL >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Typo] ES|QL Docs - "using using" in RLIKE

4 participants