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

[ES|QL] Better support for links in generated docs #113471

Open
not-napoleon opened this issue Sep 24, 2024 · 2 comments
Open

[ES|QL] Better support for links in generated docs #113471

not-napoleon opened this issue Sep 24, 2024 · 2 comments
Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team

Comments

@not-napoleon
Copy link
Member

Description

Follow up from #113263

We want to be able to include links in our generated docs, without leaking asciidoc into responses that aren't then rendered. We have two proposals for how to best do this:

1 - Strip asciidoc links from all generated files except the actual docs. There's already logic in the generation code that does this for the json files.

2 - Build a map of keywords to links and scan the generated docs for those keywords to replace with the links.

This issue is the correct place to discuss those two options, or suggest other possibilities. Note also that we currently leak markdown links at places as well.

@not-napoleon not-napoleon added :Analytics/ES|QL AKA ESQL >docs General docs changes >enhancement labels Sep 24, 2024
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Sep 24, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

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 >enhancement 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

2 participants