Better documentation

Bug #1973878 reported by Durzo
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
etcd3gw
Fix Released
Medium
Unassigned

Bug Description

I discovered this project as an alternative to the seemingly abandoned python-etcd3 library. here was my user journey:

Find project through Pypi: etcd3-gateway
Installation instructions: pip install etcd3-gateway
Results: no such library. it is actually called etcd3gw.
Project homepage points to a now archived github account, and not the openstack source control repo.

Go to openstack source control, documentation source is the same as on Pypi with little to no documentation on how to use the library. many functions missing.

Additionally, the listed bug tracker brings me here, to launchpad, which appears to be for issues relating to the ubuntu package python-etcd3gw and not the actual library.

I have no idea how to open pull requests or issues against the actual source code and the github repo is a read-only mirror.

Changed in python-etcd3gw:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to etcd3gw (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/etcd3gw/+/908582

Changed in python-etcd3gw:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to etcd3gw (master)

Reviewed: https://review.opendev.org/c/openstack/etcd3gw/+/908582
Committed: https://opendev.org/openstack/etcd3gw/commit/20ca0a4af6ab007dd40e313e777bf6808f812d75
Submitter: "Zuul (22348)"
Branch: master

commit 20ca0a4af6ab007dd40e313e777bf6808f812d75
Author: Takashi Kajinami <email address hidden>
Date: Fri Feb 9 23:14:03 2024 +0900

    Update README

    ... using the common template used by the libraries in Oslo project.

    Closes-Bug: #1973878
    Change-Id: I6d138132f507ba99cd5bbccce05b1da5d35df43f

Changed in python-etcd3gw:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/etcd3gw 2.4.0

This issue was fixed in the openstack/etcd3gw 2.4.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.