Skip to content

Conversation

@craigtaverner
Copy link
Contributor

@craigtaverner craigtaverner commented Mar 3, 2025

▶️ 👁️ URL Preview

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:

  • Add back generation of sub-files
  • Remove intermediate files (ones ending in -new or -orig)

@craigtaverner craigtaverner added >docs General docs changes Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) :Analytics/ES|QL AKA ESQL labels Mar 3, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

@craigtaverner craigtaverner added v9.0.1 auto-backport Automatically create backport pull requests when merged labels Mar 3, 2025
@leemthompo
Copy link
Contributor

Last four erroring links should be:

logstash://reference/plugins-filters-dissect.md
logstash://reference/plugins-filters-grok.md
beats://docs/reference/index.md
beats://docs/reference/filebeat/filebeat-installation-configuration.md

@craigtaverner
Copy link
Contributor Author

Last four erroring links should be:

logstash://reference/plugins-filters-dissect.md
logstash://reference/plugins-filters-grok.md
beats://docs/reference/index.md
beats://docs/reference/filebeat/filebeat-installation-configuration.md

OK. I think I've fixed these now.

@leemthompo
Copy link
Contributor

I'd recommend using absolute links to the images folder for simplicity

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.

🚗

@leemthompo leemthompo enabled auto-merge (squash) March 4, 2025 13:52
@leemthompo leemthompo merged commit efe7379 into elastic:main Mar 4, 2025
5 of 6 checks passed
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
9.0 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 123904

@leemthompo
Copy link
Contributor

there's no need to backport right now because we're only publishing docs from main but we might revisit this strategy going forward

leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Mar 6, 2025
* 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)
@leemthompo
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@leemthompo leemthompo added the auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) label Mar 6, 2025
leemthompo added a commit that referenced this pull request Mar 6, 2025
* 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]>
@craigtaverner craigtaverner mentioned this pull request Mar 7, 2025
21 tasks
@kilfoyle
Copy link
Contributor

kilfoyle commented Mar 7, 2025

Hi @leemthompo, @craigtaverner or @colleenmcginnis,

I noticed in this PR that at line 96 of esql-enrich-data.md there are three links to the Beats docs.

You also can set up [{{beats}}](beats://docs/reference/index.md), such as a [{{filebeat}}](beats://docs/reference/filebeat/filebeat-installation-configuration.md), to automatically send and index documents to your source indices. See [Getting started with {{beats}}](beats://docs/reference/index.md).

Corresponding to that, in the Beats Migrate docs from Asciidoc to Markdown PR, the docs build is currently failing with the following errors:

error::e.d.t.d.Log           :: 'elastic/elasticsearch' links to unknown file: 'docs/reference/index.md' in the 'beats' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json
Error: 'elastic/elasticsearch' links to unknown file: 'docs/reference/index.md' in the 'beats' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json
error::e.d.t.d.Log           :: 'elastic/elasticsearch' links to unknown file: 'docs/reference/filebeat/filebeat-installation-configuration.md' in the 'beats' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json
Error: 'elastic/elasticsearch' links to unknown file: 'docs/reference/filebeat/filebeat-installation-configuration.md' in the 'beats' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json

	The following errors and warnings were found in the documentation

Error: 'elastic/elasticsearch' links to unknown file: 'docs/reference/index.md' in the 'beats' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json
NOTE: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/beats/main/links.json

Those "unknown" files are present in the Beats PR, but I wonder if the link paths should be like:

[{{beats}}](beats://reference/index.md)

instead of :

[{{beats}}](beats://docs/reference/index.md)

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! 🙏

@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Mar 7, 2025

Those "unknown" files are present in the Beats PR, but I wonder if the link paths should be like:

[{{beats}}](beats://reference/index.md)

instead of :

[{{beats}}](beats://docs/reference/index.md)

@kilfoyle yep that should do the trick. 🤞

georgewallace pushed a commit to georgewallace/elasticsearch that referenced this pull request Mar 11, 2025
* 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
craigtaverner added a commit that referenced this pull request Mar 13, 2025
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).
jfreden pushed a commit to jfreden/elasticsearch that referenced this pull request Mar 13, 2025
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).
craigtaverner added a commit to craigtaverner/elasticsearch that referenced this pull request Mar 13, 2025
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).
@craigtaverner
Copy link
Contributor Author

Backport in #124214

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

Labels

:Analytics/ES|QL AKA ESQL auto-backport Automatically create backport pull requests when merged auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v9.0.0 v9.0.1 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants