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

Develop better tutorials and examples for lakeFS Python SDK usage #8726

Open
nopcoder opened this issue Feb 26, 2025 · 0 comments
Open

Develop better tutorials and examples for lakeFS Python SDK usage #8726

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

Comments

@nopcoder
Copy link
Contributor

Feedback indicates that current guides do not adequately cover practical use cases or provide clear examples of how to use lakeFS using the Python SDK.

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

Proposed Solution:

Update the current documentation structure while adding use-cases with examples.

Structure

  • Overview
    General description with capabilities
    Features and reference to by target audience (api reference for developers)
    Getting started - requirements, and how to install

  • Tutorials / User Guides
    A series of step-by-step tutorials demonstrating how to perform specific actions - similar to what we have today in a single page.
    Focus need to be one single key task.
    In-depth use cases with real-world examples.
    Error handling

  • API Reference
    Reference the current Python SDK generated SDK documentation
    Consider embedding the API, related to Refresh LakeFS Python SDK API Reference Using MkDocs #8721

  • Best Practices and Performance
    Performance relate to different ways we enable upload/download
    Explain the differences between using boto - presign or not

@nopcoder nopcoder added area/sdk/python python-wrapper docs Improvements or additions to documentation contributor labels Feb 26, 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

1 participant