1.0.1 doc updates incl start scenarios, DB persist & info, invite, and local storage #721

smoreface · 2021-03-26T00:17:47Z

Docs for various start scenarios (still some missing), database persistence with cloud and docker, and a new dedicated page for database storage info since it needed a fresh home.

Details and scenarios for CLI args and ENVVARS

Moved database storage to its own page and wrote up persistence guidance.

Responding to review feedback: - restructuring the first table - marking an arg as deprecated - fixing port syntax for docker cmd

docs/source/guide/storedata.md

- updating ENVVARs to have prefixes - removing irrelevant scenarios - updating sampling docs with API ref and correcting to be per-project - adding link to shell command - correcting a couple docker inaccuracies

Removing run LS on localhost with default settings to avoid confusion

Uncommenting local storage docs for setting up local storage as a source on cloud page

Updating signup docs with info about people page and inviting users

…abel-studio into docs/1.0.1-updates

docs/source/guide/start.md

docs/source/guide/storedata.md

- updating docker path in install and start docs - adding prediction-score-min sampling back in - clarifying details and adding links for docker compose

Adding a reference to how to set up an HTTP server and pointer links to the local storage docs for importing data from a local dir

smoreface · 2021-03-30T16:27:00Z

@niklub I believe I addressed all your review feedback, plz lmk if this can be merged or if you have additional feedback!

niklub · 2021-03-30T17:00:26Z

docs/source/guide/tasks.md

+   ```bash
+   python -m http.server 8081
+   ```
+2. Collect the links to the files provided by that HTTP server and save them to a TXT file with one URL per line. Refer to this [helper shell script in the Label Studio repository](https://github.com/heartexlabs/label-studio/blob/master/scripts/serve_local_files.sh) for one example of how to do this.


We can just point out that 1 and 2 can be done in one call ./script/serve_local_files.sh directory/with/files *.jpg

Updating local storage steps to be clearer about the options and what the script does

github-actions · 2021-03-30T17:21:16Z

Unit Test Results

    1 files ±0     1 suites ±0 4m 7s ⏱️ +10s
337 tests ±0 261 ✔️ ±0 76 💤 ±0 0 ❌ ±0

Results for commit 50a7e0d. ± Comparison against base commit fb07c86.

* Add tests for azure * Add localfiles storage WIP, fix regex in GCS * Don't get ML backend prediction in disconnected/error states * Feature/localfiles storage (#677) * Add localfiles import storage * Change serving url to data/local-files; Add document_root env variable * Fix migration predictions; check upload exists (#680) * Fix migration predictions; check upload exists * Fill score field for prediction * Fix io storages tests * Store organization_id in User model (#698) * Fix dockerfiles (#686) * Add docker entrypoints, fix nginx paths * Fix readme, add hooks, add build production bundle command * Move nginx config into deploy folder * Add API reference to docs. * Remove version from dockerignore * Fix prebuild script * Fix dockerhub hook * Fix hook * Add environment installation into prehook * Print out env setup * Upgrade pip in hook * Change pip -> pip3 in hook * Install python3.8 * Apt repo * Accept prompts on apt install * Try again installing python3.7 * Force yes * Try update alternatives * Install pip * Upgrade pip again * Fix github workflow * Print script dir in workflows * Fix tests * Add scripts * Fix manifest version_.py Co-authored-by: nik <nik@heartex.net> Co-authored-by: makseq-ubnt <makseq@gmail.com> * Update command line args and examples Add examples and tables for command line arguments for starting label studio * Update frontend build * User invite via link (#703) * People page on React * Invite link modal * Invite api and setting for disabling signup for everyone * Fix invite api docs * Update frontend builds * Invite link get and reset * UI fixes * Check signup setting only for post request * Pass token to signup form * Update download scripts Co-authored-by: Nikita Skryabin <nr@fenelon.ru> * Add debug contextlog var * Do not show validation warning for empty projects (#697) * Fix version * Show warning only if the project already set up * Add debug contextlog var Co-authored-by: nik <nik@heartex.net> * Update build * Update DM to fix selection reset on filters change (#713) * Add setting for create_organization (#715) * Load get_object_with_check_and_log with load_func * Add annotator support in export * Rolling back my earlier commits So I can properly do a PR with all of them off a branch instead * Fix DM initialization and loading issues (#720) * Export Storage JSON support task inside of annotations * Expand completed_by in storage annotations * Make sample task creation and config validation through POST instead of GET (#708) * Make sample task creation and config validation through POST instead of GET * Fix imports * Fix validation tests * Fix label config from request data Co-authored-by: makseq-msi3 <makseq@gmail.com> * Fix/tasks migrations dependencies (#726) * Using utf8 as default encoding (#723) * Fix tasks migration dependency Co-authored-by: Alan Lee <secsilm@outlook.com> Co-authored-by: nik <nik@heartex.net> * Add save_user setting * Handle list placeholders in test framework * Change version * Support git links in requirements.txt via setup.py * Add simple export test * Fix completed_by while import. Update react-app * Fix tests * Fix test bulk * Revert task serializer with empty data * Fix delete task action caused by signals * Revert prediction-score-min on sampling initializer * Fix imports * Fixing urls+hostname * Refactor TaskSerializer in DM via task_serializer_class * Fix tests * Validate s3 bucket prefixes, hook ML backend in quickview, change template orders * Check for essential config data before dropping the tabs * Fix unexisted attribute in api * Fix simple server script * Fix local_storage syncing json tasks * 1.0.1 doc updates incl start scenarios, DB persist & info, invite, and local storage (#721) * Update start label studio for CLI args Details and scenarios for CLI args and ENVVARS * DB storage + persistence Moved database storage to its own page and wrote up persistence guidance. * Review feedback updates Responding to review feedback: - restructuring the first table - marking an arg as deprecated - fixing port syntax for docker cmd * feedback updates - updating ENVVARs to have prefixes - removing irrelevant scenarios - updating sampling docs with API ref and correcting to be per-project - adding link to shell command - correcting a couple docker inaccuracies * Review feedback Removing run LS on localhost with default settings to avoid confusion * Local storage docs Uncommenting local storage docs for setting up local storage as a source on cloud page * Update docs for invite link Updating signup docs with info about people page and inviting users * Review feedback again - updating docker path in install and start docs - adding prediction-score-min sampling back in - clarifying details and adding links for docker compose * Adding local directory import Adding a reference to how to set up an HTTP server and pointer links to the local storage docs for importing data from a local dir * review feedback Updating local storage steps to be clearer about the options and what the script does * Fix empty active organization on import * Enable predictions for dm paginated tasks * Add disabled local serving explanation message * Rebuild frontend Co-authored-by: Sergei Ivashchenko <triklozoid@gmail.com> Co-authored-by: nik <nik@heartex.net> Co-authored-by: makseq-ubnt <makseq@gmail.com> Co-authored-by: smoreface <smoreface@users.noreply.github.com> Co-authored-by: Nikita Skryabin <nr@fenelon.ru> Co-authored-by: Nick Skriabin <767890+nicholasrq@users.noreply.github.com> Co-authored-by: Alan Lee <secsilm@outlook.com>

smoreface added 2 commits March 25, 2021 15:40

Update start label studio for CLI args

a54fa52

Details and scenarios for CLI args and ENVVARS

DB storage + persistence

c89894b

Moved database storage to its own page and wrote up persistence guidance.

smoreface requested review from makseq and niklub March 26, 2021 00:17

smoreface changed the base branch from master to release/1.0.1 March 26, 2021 00:18