-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
[docs] Add documentation for JinaAI service #118782
base: main
Are you sure you want to change the base?
Conversation
Documentation preview: |
@elasticmachine test this |
run docs-build |
Hi! Just a drive by reminder to make the same doc changes in https://github.com/elastic/elasticsearch-specification/tree/main/specification/inference, since we'll be retiring these manually-maintained asciidoc files soon. |
Hey @lcawl , is there an example available? |
There's info in https://github.com/elastic/elasticsearch-specification/blob/main/docs/doc-comments-guide.md We're in the process of moving the examples from the old asciidoc pages so we can retire them completely. |
@JoanFM you have added the docs to the git tree, but haven't included the |
Done, thanks! |
ef1a0df
to
a1fa8d7
Compare
@JoanFM It looks like your subsequent commits aren't triggering CI You can use the comments I added earlier to launch them:
and
This is a good example of where building the docs locally would shorten feedback cycles and save some iteration time :) |
@elasticmachine test this |
run docs-build |
@elasticmachine test this |
run docs-build |
Co-authored-by: Liam Thompson <[email protected]>
@elasticmachine test this |
run docs-build |
@JoanFM you have multiple example snippets that need to be skipped |
@elasticmachine test this |
run docs-build |
@JoanFM normally CI runs on every commit, I think we hit an edge case here because the file wasn't included initially 😄. It's usually not as painful a process as this (I promise), but again, good argument for testing locally. |
@elasticmachine test this |
run docs-build |
Co-authored-by: Liam Thompson <[email protected]>
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.
Few suggestions, once addressed we should be able to run docs checks one last time 😅
Co-authored-by: Liam Thompson <[email protected]>
Hey @leemthompo , changes applied |
Pinging @elastic/ml-core (Team:ML) |
Pinging @elastic/es-docs (Team:Docs) |
@elasticmachine test this |
run docs-build |
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.
LGTM! Thanks for your patience with the iterations, CI can be a bit of pain when you're an external contributor. ❤️
@JoanFM I've opened #118943 to track this and assigned it to one of the ML writers. He will take care of it once he returns from PTO. And thanks for the PR ❤️ |
Documentation piece referencing #118652