Skip to content

[DOC] Add more Python Client code examples to main Elasticsearch Docs #2429

Closed
@stefnestor

Description

@stefnestor

👋 howdy, team!

Describe the feature:

@scranberryjam & I would like to add more Elasticsearch Client content to the Elasticsearch API docs.

example difference

Examples for Cluster API's


(Taking Python as the first language, since I'm most comfortable with it,) It doesn't appear these code examples are in-line in the Elasticsearch docs code. Instead it appears Python examples surface in Elasticsearch Docs via this repo's code for "doc examples".

Checking these files' history, it appears these may be auto-generated (last done 2023Sep via #2312, commit before)? (Is that part of the Auto-generate API?)

Do these need to be re-generated periodically or is there a project here I could help on to fill in more pages?

Initial examples confirmed not having ES-doc Python code examples: Elasticsearch doc 👉 ES-Py doc > ClusterClient

EDIT : I believe the "list to generate" is determined from this code.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions