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

[docs] Add documentation for JinaAI service #118782

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

JoanFM
Copy link
Contributor

@JoanFM JoanFM commented Dec 16, 2024

Documentation piece referencing #118652

Copy link
Contributor

Documentation preview:

@davidkyle davidkyle added >docs General docs changes :ml Machine learning v9.0.0 v8.18.0 labels Dec 17, 2024
@davidkyle davidkyle self-assigned this Dec 17, 2024
@timgrein timgrein requested a review from leemthompo December 17, 2024 13:01
@leemthompo
Copy link
Contributor

@elasticmachine test this

@leemthompo
Copy link
Contributor

run docs-build

@lcawl
Copy link
Contributor

lcawl commented Dec 17, 2024

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.

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

Hey @lcawl , is there an example available?

@lcawl
Copy link
Contributor

lcawl commented Dec 17, 2024

Hey @lcawl , is there an example available?

There's info in https://github.com/elastic/elasticsearch-specification/blob/main/docs/doc-comments-guide.md
Basically just the addition of comments to the specification so that when the make transform-to-openapi command runs, there's good descriptions in the output. The resulting OpenAPI files are published here: https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-inference

We're in the process of moving the examples from the old asciidoc pages so we can retire them completely.

@leemthompo
Copy link
Contributor

@JoanFM you have added the docs to the git tree, but haven't included the asciidoc file in the inference API index page so the build system isn't finding it :)

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

@JoanFM you have added the docs to the git tree, but haven't included the asciidoc file in the inference API index page so the build system isn't finding it :)

Done, thanks!

@JoanFM JoanFM force-pushed the docs-inference-jinaai branch from ef1a0df to a1fa8d7 Compare December 17, 2024 16:54
@leemthompo
Copy link
Contributor

@JoanFM It looks like your subsequent commits aren't triggering CI

You can use the comments I added earlier to launch them:

@elasticmachine test this

and

run docs-build

This is a good example of where building the docs locally would shorten feedback cycles and save some iteration time :)

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

@elasticmachine test this

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

run docs-build

@leemthompo
Copy link
Contributor

@elasticmachine test this

@leemthompo
Copy link
Contributor

run docs-build

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

@elasticmachine test this

@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 17, 2024

run docs-build

@leemthompo
Copy link
Contributor

@JoanFM you have multiple example snippets that need to be skipped

@leemthompo
Copy link
Contributor

@elasticmachine test this

@leemthompo
Copy link
Contributor

run docs-build

@leemthompo
Copy link
Contributor

@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.

@leemthompo
Copy link
Contributor

@elasticmachine test this

@leemthompo
Copy link
Contributor

run docs-build

@JoanFM JoanFM requested a review from leemthompo December 18, 2024 10:05
@JoanFM JoanFM requested a review from leemthompo December 18, 2024 10:35
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.

Few suggestions, once addressed we should be able to run docs checks one last time 😅

docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-jinaai.asciidoc Outdated Show resolved Hide resolved
@JoanFM
Copy link
Contributor Author

JoanFM commented Dec 18, 2024

Hey @leemthompo ,

changes applied

@JoanFM JoanFM marked this pull request as ready for review December 18, 2024 10:52
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Dec 18, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo
Copy link
Contributor

@elasticmachine test this

@leemthompo
Copy link
Contributor

run docs-build

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.

LGTM! Thanks for your patience with the iterations, CI can be a bit of pain when you're an external contributor. ❤️

@davidkyle
Copy link
Member

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.

@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 ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants