Skip to content

Add documentation for Latch #1522

@wout

Description

@wout

After reviewing, the luckyframework/lucky#2016 PR will be ready. I'll probably add more features later, but it's a big enough PR as it is. Once that's merged I'll start working on the documentation for it. This is an overview of the sections that need to be documented (also open for suggestions of course).

  • Configuration
    • Setting up Memory and File stores in development
    • Setting up S3 stores for production
    • Using File stores in production
    • Path prefixes
  • Uploaders
    • Configuring an uploader
    • Extending the StoredFile class
  • Extractors
    • Using extractors
    • Creating simple extractors
    • Creating extractors with CLI dependencies
  • Setup
    • Setting up the Model
    • Setting up the SaveOperation
    • Using file validations
    • How a DeleteOperation handles uploads
  • Uploads in pages
    • Rendering uploaded files
    • File uploads in forms
    • Deleting uploaded files
    • Presigned URLs with S3 stores

This will be a complete rewrite of the Uploading Files section.

Thinking about it, if writing this section would help with getting a clear view on the totality of the luckyframework/lucky#2016 PR, I'd be happy to work on it first.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions