From cfabf6482ffce9090b9583bb1db1b4e82c66b48d Mon Sep 17 00:00:00 2001 From: Josh GM Walker <56300765+Josh-Walker-GM@users.noreply.github.com> Date: Thu, 19 Sep 2024 17:03:39 +0100 Subject: [PATCH] fix(docs): warn that uploads/storage is experimental (#11590) We want to have this labelled as experimental. --- docs/docs/uploads.md | 10 ++++++++++ docs/versioned_docs/version-8.1/uploads.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/docs/uploads.md b/docs/docs/uploads.md index 2f622158c79d..4a465624ac05 100644 --- a/docs/docs/uploads.md +++ b/docs/docs/uploads.md @@ -1,5 +1,15 @@ # Uploads & Storage +:::warning Experimental + +The storage and upload functionality is currently experimental. + +While we believe this feature will be included in the framework the interface is currently subject to significant change. Breaking changes will be made in minor and patch releases until the feature is released as stable after which normal SemVer rules will apply. + +We'd love to hear any feedback you might have on our [community forum](https://community.redwoodjs.com/). + +::: + Getting started with file uploads can open up a world of possibilities for your application. Whether you're enhancing user profiles with custom avatars, allowing document sharing, or enabling image galleries - Redwood has an integrated way of uploading files and storing them. There are two parts to this: diff --git a/docs/versioned_docs/version-8.1/uploads.md b/docs/versioned_docs/version-8.1/uploads.md index 5e47680c585f..9b6a6e71a760 100644 --- a/docs/versioned_docs/version-8.1/uploads.md +++ b/docs/versioned_docs/version-8.1/uploads.md @@ -1,5 +1,15 @@ # Uploads & Storage +:::warning Experimental + +The storage and upload functionality is currently experimental. + +While we believe this feature will be included in the framework the interface is currently subject to significant change. Breaking changes will be made in minor and patch releases until the feature is released as stable after which normal SemVer rules will apply. + +We'd love to hear any feedback you might have on our [community forum](https://community.redwoodjs.com/). + +::: + Getting started with file uploads can open up a world of possibilities for your application. Whether you're enhancing user profiles with custom avatars, allowing document sharing, or enabling image galleries - Redwood has an integrated way of uploading files and storing them. There are two parts to this: