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 ES|QL doc structure #1403

Merged
merged 7 commits into from
May 31, 2024
Merged

Conversation

marciw
Copy link
Contributor

@marciw marciw commented May 22, 2024

Adds an esql.asciidoc file that sets up a basic structure for the ES|QL documentation. Based on @szabosteve's Java client docs PR (#789).

This includes adding a folder structure for helpers instead of keeping the docs all on one page (but we can undo that).

@ezimuel This needs expanding and tailoring for the PHP client (it's really just placeholder text from the Java client docs). All other feedback is welcome, especially because I'm still so new to Elastic and to the client docs.

Preview

@marciw marciw self-assigned this May 22, 2024
@marciw marciw marked this pull request as ready for review May 23, 2024 00:07
@marciw marciw requested review from ezimuel and szabosteve May 23, 2024 00:07
@ezimuel
Copy link
Contributor

ezimuel commented May 28, 2024

@marciw sorry for the late reply. I need to adapt the context to the PHP client using the approach that I blogged here.

@marciw
Copy link
Contributor Author

marciw commented May 28, 2024

@marciw sorry for the late reply. I need to adapt the context to the PHP client using the approach that I blogged here.

@ezimuel Ah, great! I'm sure it will take me longer than it would you, but if you like, I can put together a skeleton/notes or just take a crack at adapting it and you can expand...? Or happy to review and edit.

@ezimuel
Copy link
Contributor

ezimuel commented May 29, 2024

@marciw I adapted the context for PHP with some examples. Let me know what do you think, thanks!

@marciw
Copy link
Contributor Author

marciw commented May 29, 2024

@marciw I adapted the context for PHP with some examples. Let me know what do you think, thanks!

@ezimuel I did a minor edit -- take a look when you can and feel free to veto my changes. Thanks again for writing this up! 🏆

Copy link
Contributor

@ezimuel ezimuel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ezimuel ezimuel merged commit fd8aa92 into elastic:main May 31, 2024
8 checks passed
@marciw marciw deleted the esql-docs-structure-php branch June 2, 2024 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants