influxdata / influxdata/influxdb-client-python

Doc improvment

Open
#646 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
793
Forks
186
Avg merge
3h 2m
Merged PRs (30d)
1

Description

Specifications

Minor item... As I'm navigating various online docs, I found these two:
old v1 client library: https://influxdb-python.readthedocs.io/en/latest/include-readme.html
new v2 client library: https://influxdb-client.readthedocs.io/en/stable/
It would have been convenient (for me) for the old doc to link to the newer doc, but that github repository is archived:
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.
This is in the influxdata github repository so I will just leave this here as a suggested fix if that's OK.
Of course, I could have navigated github itself and found v2 docs that way...
More generally - are there no conventions (in Python) for indicating which versions we are working with? I'm currently learning python 3.12, influx client 2, influx 2.x and regularly stumbling into older examples and documentation. I have an extensive IT background so ought to know how to locate docs and resources, but it's like we're purposely making life hard for our (future) selves.

Code sample to reproduce problem

N/A

Expected behavior

N/A

Actual behavior

N/A

Additional info

This has been added by Zoe - The devrel. To come back and address in here, the v1 library, and the docs

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the v1 and v2 documentation pages linked in the issue, then inspect the documentation entry points in this client repository and the referenced v1 library. Done should include a clear path from the old documentation to the v2 documentation and guidance that distinguishes the supported Python, client-library, and InfluxDB versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.