Tracking Issue for multilingual clients document catching up

[tisonkun]

Search before asking

• I searched in the issues and found nothing similar.

Motivation

We have a Client Libraries page to host all official client libraries documents. Despite the Java client's document being relatively completed, documents for multilingual clients are outdated and less maintained.

This issue tracks the effort to document what we already implemented for multilingual clients, focusing on the C++ client, the Python client, and the Node.js client - all based on the core C++ client library.

Solution

The catching-up plan is based on:

1. Java client's document for the overall structure.
2. Feature Matrix for what we already implemented.

Layout

Top-level layout (continuously updating):

• Brief introducation
• Installation
• Connection URLs
• Client
• Producer
• Consumer
• Reader
• Table View
• Schema
• Authentication

Common

• Sync (Duplicate) "Connection URLs" section for all clients #17303
• Turn on syntax highlight for all related programming languages #17307

C++

• [Doc][CPP] Simplify the Install section and promote a top-level "Install" title #17385

Python

• [Doc] Updating Python installation section according to C++ client doc structure changes #17794
• Convert handy examples to a structural layout (Client, Producer, Consumer, Reader)

Node.js

Are you willing to submit a PR?

• I'm willing to submit a PR!

[tisonkun]

@RobertIndie @shibd when you merge some patches requiring docs, you can cc me in this thread and I'm glad to track them and help on the docs side.

[github-actions]

The issue had no activity for 30 days, mark with Stale label.

[tisonkun]

Closed as halted and partially delivered. We moved out the C++/Python client from the main repo, and I've worked on the API docs, which are delivered as #17917.

Sooner or later we can restructure the client library in the proposed structure above, but it will be a new turn.