Skip to content

Refine .gitattributes to hide generated docs changes #124742

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 13, 2025
Merged

Refine .gitattributes to hide generated docs changes #124742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/parser/EsqlBasePar
x-pack/plugin/esql/src/main/generated/** linguist-generated=true
x-pack/plugin/esql/src/main/generated-src/** linguist-generated=true

# ESQL functions docs are autogenerated. More information at `docs/reference/esql/functions/README.md`
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
Copy link
Contributor

@ivancea ivancea Mar 13, 2025

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

@craigtaverner craigtaverner Mar 13, 2025

Choose a reason for hiding this comment

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

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.

docs/reference/query-languages/esql/images/** linguist-generated=true
docs/reference/query-languages/esql/kibana/** linguist-generated=true