Skip to content
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

ESQL: meta issue: migrate docs to markdown #121205

Open
4 tasks
alex-spies opened this issue Jan 29, 2025 · 6 comments
Open
4 tasks

ESQL: meta issue: migrate docs to markdown #121205

alex-spies opened this issue Jan 29, 2025 · 6 comments
Assignees
Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team

Comments

@alex-spies
Copy link
Contributor

alex-spies commented Jan 29, 2025

Future docs are going to be markdown-based, making our asciidoc-based docs obsolete. They will be following the syntax described here.

TODO:

  • Migrate ESQL's automatic doc generation to respect the new syntax
  • For any manually generated docs added after Jan 29, forward-port them from 8.x to the 9.x branch using the new syntax once the new syntax is being used:
    • docs for LOOKUP JOIN
    • docs for CHANGE_POINT
@alex-spies alex-spies added :Analytics/ES|QL AKA ESQL >docs General docs changes labels Jan 29, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Jan 29, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo
Copy link
Contributor

We might want to think about better supporting links in the generated code too per #113471

@nik9000 nik9000 self-assigned this Feb 11, 2025
@marciw
Copy link
Contributor

marciw commented Feb 11, 2025

cc @Mpdreamz @reakaleek @bmorelli25 for awareness and advice! 🙏 (not urgent)

@marciw
Copy link
Contributor

marciw commented Feb 11, 2025

We also have this related issue on the docs side, including mentions of the ES|QL generated docs: https://github.com/elastic/docs-projects/issues/276

@leemthompo
Copy link
Contributor

leemthompo commented Feb 12, 2025

Tip

Note

The bulk of the ESQL docs are in temporary repo awaiting rerouting. You'll find more syntax examples there.

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 Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

5 participants