-
Notifications
You must be signed in to change notification settings - Fork 25.6k
Split ESQL functions/operators docs files #123904
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
Split ESQL functions/operators docs files #123904
Conversation
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
|
Last four erroring links should be: |
OK. I think I've fixed these now. |
|
I'd recommend using absolute links to the images folder for simplicity |
leemthompo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚗
💔 Backport failed
You can use sqren/backport to manually backport by running |
|
there's no need to backport right now because we're only publishing docs from |
* Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links (cherry picked from commit efe7379)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
* Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links (cherry picked from commit efe7379) Co-authored-by: Craig Taverner <[email protected]>
|
Hi @leemthompo, @craigtaverner or @colleenmcginnis, I noticed in this PR that at line 96 of Corresponding to that, in the Beats Migrate docs from Asciidoc to Markdown PR, the docs build is currently failing with the following errors: Those "unknown" files are present in the Beats PR, but I wonder if the link paths should be like:
instead of :
I'm still new to cross-repo linking, so I figured I'd ask first. If any of you can confirm that the change makes sense, I'll open up a PR. Thanks! 🙏 |
@kilfoyle yep that should do the trick. 🤞 |
* Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links
Building on the work started in #123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
Building on the work started in elastic#123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
Building on the work started in elastic#123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
|
Backport in #124214 |
Next step in splitting the ES|QL reference documentation for functions and operators into the sub-files needed for generating the docs automatically.
I have a few more actions to take, either in this PR or in a next one: