Refine .gitattributes to hide generated docs changes #124742
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
craigtaverner
added
>non-issue
Team:Analytics
Collaborator
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
21 tasks
ivancea
approved these changes
Mar 13, 2025
| docs/reference/esql/functions/*/** linguist-generated=true | ||
| # ESQL functions docs are autogenerated. More information at `docs/reference/query-languages/esql/README.md` | ||
| docs/reference/query-languages/esql/_snippets/functions/*/** linguist-generated=true | ||
| #docs/reference/query-languages/esql/_snippets/operators/*/** linguist-generated=true |
Contributor
There was a problem hiding this comment.
Is this not ready yet? I would maybe add it anyway, it will just be collapsed by default. A to not open more PRs for this
Contributor
Author
There was a problem hiding this comment.
The operators are still mostly manually created. I thought this setting would hide these changes from PRs and we should not do that for manually edited files. But I hope we can fix this moving forward. Certainly the previous PR took a reasonable step closer to automating operator docs generating. Previously only the types list was generated. Now we can also generate detailedDescription, notes and examples. But there are a few parts missing and a few operators that are 100% manual docs.
jfreden
pushed a commit
to jfreden/elasticsearch
that referenced
this pull request
Mar 13, 2025
craigtaverner
added a commit
to craigtaverner/elasticsearch
that referenced
this pull request
Mar 13, 2025
elasticsearchmachine
pushed a commit
that referenced
this pull request
Mar 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR at #124312 created a lot of generated docs in a new location. This PR updates the .gitattributes file to hide these in the new locations.