elastic / elastic/docs

Allow Customisation of Elasticsearch Clients Landing page

Open
#1,114 11 comments 0 reactions 0 assignees View on GitHub
content defer docs-build versions
Dominant language
Ruby
Stars
265
Forks
347
Avg merge
3d 15h
Merged PRs (30d)
2

Description

It would be great if we could customise the ([clients landing page](https://www.elastic.co/guide/en/elasticsearch/client/index.html)).

At present, the page is generated from https://github.com/elastic/docs/blob/6dd5ec731a1bfcf6c6f2f0aaf8154bf2b815dd08/conf.yaml

...and presented to the user as a list of officially supported clients.

This is useful, but we would like to enhance this page to incorporate:

- Links to the Github repository for each client
- Links to the binaries/downloads for each client (e.g. Nuget packages for .NET client)
- Answers to common questions, for example:
- What version of client and server can I use?
- How do I upgrade the server and client? at the same time, client first, server first?
- What is the roadmap / release schedule for feature X? When is version X being released?
- What are the formats for the request and response bodies
- A list of community supported clients (or a link to the page) for popular languages
- Links to breaking changes documentation for each client?

Could we perhaps suggest the following:

1. Introduce a new index page in the docs repo to become the landing page.
2. In this new index page, insert an include file that will bring in the automatically generated list of officially supported clients (i.e. what we have already).
3. Give write access to this new index page to the clients team, so that they can make changes.

This would allow us to iterate quickly on the content and format of the page.

Does this sound feasible?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.