Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Overview, Tutorials, and Guides for lakeFS Python SDK #8726

Open
nopcoder opened this issue Feb 26, 2025 · 1 comment
Open

Improve Overview, Tutorials, and Guides for lakeFS Python SDK #8726

nopcoder opened this issue Feb 26, 2025 · 1 comment
Labels
area/sdk/python contributor docs Improvements or additions to documentation python-wrapper

Comments

@nopcoder
Copy link
Contributor

nopcoder commented Feb 26, 2025

Context:

Feedback suggests that the existing documentation does not sufficiently demonstrate practical usage of the lakeFS Python SDK or provide clear, task-focused examples.

Slack reference: https://lakefs.slack.com/archives/C01APUNTSGH/p1740305114751379

Proposed Solution:

Revise and expand the documentation to help users better understand and apply the lakeFS Python SDK in real-world scenarios.

Suggested Structure:

  • Overview
    • High-level description of the SDK and its capabilities.
    • Key features and relevant links by user role (e.g., developers).
    • Getting started: installation steps and requirements.
  • Tutorials / User Guides
    • Step-by-step guides focused on specific tasks.
    • Examples based on real-world use cases.
    • Coverage of error handling patterns and tips.
  • Best Practices and Performance
    • Guidance on optimizing upload/download performance.
    • Comparison of different methods, such as using boto3 with or without presigned URLs.
@nopcoder nopcoder added area/sdk/python python-wrapper docs Improvements or additions to documentation contributor labels Feb 26, 2025
@guy-har guy-har assigned nopcoder and unassigned nopcoder Mar 13, 2025
@ozkatz
Copy link
Collaborator

ozkatz commented Mar 19, 2025

@nopcoder let's separate the guides/overview (product task) from the reference (R&D task)

@nopcoder nopcoder changed the title Develop better tutorials and examples for lakeFS Python SDK usage Improve Overview, Tutorials, and Guides for lakeFS Python SDK Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/sdk/python contributor docs Improvements or additions to documentation python-wrapper
Projects
None yet
Development

No branches or pull requests

2 participants