From 6c677ae15e383aba0d57b70660534497a16a24ee Mon Sep 17 00:00:00 2001 From: Max Tkachenko Date: Tue, 19 Nov 2024 18:09:56 +0000 Subject: [PATCH] docs: Update direct uploads warning (#6686) Co-authored-by: caitlinwheeless --- docs/source/guide/tasks.md | 36 ++++++++++++++++++++-------- docs/themes/v2/source/css/styles.css | 5 ++++ 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/docs/source/guide/tasks.md b/docs/source/guide/tasks.md index bb6983eca17d..e6483ffd1dee 100644 --- a/docs/source/guide/tasks.md +++ b/docs/source/guide/tasks.md @@ -41,12 +41,20 @@ Get data into Label Studio by importing files, referencing URLs, or syncing with * It’s best to keep about 100k tasks / 100k annotations per project for optimal performance. * Avoid frequent imports because each new import requires lengthy background operations. One import per 30 seconds will work without overloads. -!!! warning - For large projects or business critical projects, do not [upload media files through the Label Studio interface](#Import-data-from-the-Label-Studio-UI). This is especially true for files such as images, audio, video, timeseries, etc. - - Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. You will also face challenges when you want export your data or move it to another Label Studio instance or even just redeploy Label Studio. Finally, Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources. +!!! attention + For large projects or business critical projects, do not [upload media files through the Label Studio interface](#Import-data-from-the-Label-Studio-UI). This is especially true for files such as images, audio, video, timeseries, etc. + + Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources. - We strongly recommend that you configure [source storage](storage) instead. + **Risks when uploading through the UI**:
+ You will face challenges when attempting to do the following: + + * Importing tasks with predictions + * Exporting your data + * Moving your data to another Label Studio instance + * Redeploying Label Studio + + We ***strongly*** recommend that you configure [source storage](storage) instead. ## Types of data you can import into Label Studio @@ -506,12 +514,20 @@ If you're running Label Studio on Docker and want to add local file storage, you ## Import data from the Label Studio UI -!!! warning - For large projects or business critical projects, do not upload media files through the Label Studio interface. This is especially true for files such as images, audio, video, timeseries, etc. - - Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. You will also face challenges when you want export your data or move it to another Label Studio instance or even just redeploy Label Studio. Finally, Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources. +!!! attention + For large projects or business critical projects, do not [upload media files through the Label Studio interface](#Import-data-from-the-Label-Studio-UI). This is especially true for files such as images, audio, video, timeseries, etc. + + Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources. - We strongly recommend that you configure [source storage](storage) instead. + **Risks when uploading through the UI**:
+ You will face challenges when attempting to do the following: + + * Importing tasks with predictions + * Exporting your data + * Moving your data to another Label Studio instance + * Redeploying Label Studio + + We ***strongly*** recommend that you configure [source storage](storage) instead. To import data from the Label Studio UI, do the following: 1. On the Label Studio UI, open the Data Manager page for a specific project. diff --git a/docs/themes/v2/source/css/styles.css b/docs/themes/v2/source/css/styles.css index e166bd56cfde..c86554818d9b 100644 --- a/docs/themes/v2/source/css/styles.css +++ b/docs/themes/v2/source/css/styles.css @@ -984,6 +984,11 @@ ul { padding-left: 1.5rem; } +.content-markdown div.admonition ol, +.content-markdown div.admonition ul { + padding-left: 3.0rem; +} + /* .content-markdown ol li ul li { margin-top: 0;