search

elastic / elasticsearch-php

Official PHP client for Elasticsearch.
https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html
MIT License
5.25k stars 963 forks source link

[DOCS] Add ES|QL doc structure #1403

Closed marciw closed 1 month ago

marciw commented 1 month ago

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

ezimuel commented 1 month ago

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

marciw commented 1 month ago

@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 commented 1 month ago

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

marciw commented 1 month ago

@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! 🏆