Add warning about dataset sharing when running `tfe-open`.

Open Beginner friendly
#106 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start at the entry point for the tfe-open command and inspect how its user-facing output is assembled. Run tfe-open to verify the warning explains that datasets are served locally and cannot be shared directly, and that it links to the TFE migration documentation.

Written by the indexing model from the issue text.

Description

new feature

Use Case

Users were sometimes confused about how to share dataset opened with tfe-open with other collaborators. Because tfe-open runs local servers (localhost), the links cannot be shared directly.

Acceptance Criteria

  • Add warning/info text when running tfe-open to explain that datasets are being opened locally and cannot be directly shared. Link to shared documentation in TFE on how to migrate from local tools to our public deployment.

Details

Please provide any helpful specifications

Dominant language
Python
Stars
4
Forks
1
Avg merge
3d 11h
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AllenCell/tfe-data

All issues in AllenCell/tfe-data

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.