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

Document highlevel filesystem APIs #62

Closed
1 task done
chillu opened this issue Aug 29, 2017 · 0 comments
Closed
1 task done

Document highlevel filesystem APIs #62

chillu opened this issue Aug 29, 2017 · 0 comments

Comments

@chillu
Copy link
Member

chillu commented Aug 29, 2017

Overview

The asset abstraction in 4.x changes APIs in major ways, and makes the underlying system a lot more complex - to the point where even core committers like myself can't reliably trace through operations like "does File->delete() delete from the filesystem or not?". This means we need to rely on documentation more strongly.

There's three pages on this topic:
https://docs.silverstripe.org/en/4/developer_guides/files/file_management/
https://docs.silverstripe.org/en/4/developer_guides/files/file_security/
https://docs.silverstripe.org/en/4/developer_guides/files/images/

ACs

  • As a seasoned or new SilverStripe dev, I can understand the following:
    • Changed default behaviour of delete() in upgrade guide (this isn't sufficient)
    • An overview of how files are handled in SilverStripe (potentially with a diagram or two?)
    • How protected assets are handled (and it's limitations)
    • How file drafts and publishing it's handled (highlevel, point to detailed versioned docs)
    • How to perform common operations on files and their impact (e.g. rename, move, delete)
    • How relationships are handled to other content (HTMLText, has_many, many_many)
    • Why it's not a good idea to have a has_many on File (or assign $owns on a many_many with files)
    • Image uploads and allowed_extensions restrictions (currently mentioned in "File Security", but too far down the page)

PRs

@chillu chillu added this to the Recipe 4.0.0 milestone Aug 29, 2017
@chillu chillu changed the title Document filesystem use Document highlevel APIs Aug 29, 2017
@chillu chillu changed the title Document highlevel APIs Document highlevel filesystem APIs Oct 6, 2017
@chillu chillu modified the milestones: Recipe 4.0.0, 4.0.0-rc1 Oct 6, 2017
@tractorcow tractorcow self-assigned this Oct 19, 2017
tractorcow pushed a commit to open-sausages/silverstripe-framework that referenced this issue Oct 19, 2017
@tractorcow tractorcow removed their assignment Oct 19, 2017
@flamerohr flamerohr assigned flamerohr and unassigned flamerohr Oct 19, 2017
tractorcow pushed a commit to open-sausages/silverstripe-framework that referenced this issue Oct 20, 2017
tractorcow pushed a commit to open-sausages/silverstripe-framework that referenced this issue Oct 24, 2017
unclecheese pushed a commit to silverstripe/silverstripe-framework that referenced this issue Oct 24, 2017
* DOCS Improve high level file documentation
Fixes silverstripe/silverstripe-assets#62

* Updates based on feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants