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

[Docs] flytectl demo vs flytectl sandbox #3791

Open
2 tasks done
Tracked by #5783
shekhar-kotekar opened this issue Jun 20, 2023 · 9 comments
Open
2 tasks done
Tracked by #5783

[Docs] flytectl demo vs flytectl sandbox #3791

shekhar-kotekar opened this issue Jun 20, 2023 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@shekhar-kotekar
Copy link

shekhar-kotekar commented Jun 20, 2023

Description

As of now there are 2 ways to create a fully standalone minimal environment for running Flyte. One is using flytectl demo start command and other is with flytectl sandbox start command. Document for demo is here and document for sandbox is here.

Having these 2 different ways for the same thing is confusing for a new comer because of multiple reasons:

  1. They don't know which is better or preferred way
  2. Which is used by Flyte team internally?
  3. Is any approach better or worse than the other?
  4. Is there any plan to deprecate one of them? If yes then what's the plan / dates, etc?

This hard to find document says that demo is lighter / better but there isn't any action or ticket to manage this document hence creating this ticket. Hopefully it is not a duplicate issue.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@shekhar-kotekar shekhar-kotekar added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Jun 20, 2023
@welcome
Copy link

welcome bot commented Jun 20, 2023

Thank you for opening your first issue here! 🛠

@shekhar-kotekar shekhar-kotekar changed the title [Docs] [Docs] flytectl demo vs flytectl sandbox Jun 20, 2023
@pingsutw
Copy link
Member

@wild-endeavor @eapolinario, should we deprecate the sandbox?

@wild-endeavor
Copy link
Contributor

we should update flytectl first, and then just make demo an alias of sandbox.

@thomasjpfan thomasjpfan removed the untriaged This issues has not yet been looked at by the Maintainers label Dec 5, 2023
@davidmirror-ops
Copy link
Contributor

I think this is done?

@davidmirror-ops
Copy link
Contributor

I think we should now remove references to flytectl sandbox? https://docs.flyte.org/en/latest/flytectl/sandbox.html

@RaghavMangla
Copy link
Contributor

Hi! I would like to work on this issue

@davidmirror-ops
Copy link
Contributor

@RaghavMangla thanks for your willingness to contribute. Considering you already have 6 issues assigned to you, and following the principle of "first come first serve" we'd like to encourage you to send PRs for the issues where you are already an assignee and then, if no one has taken this one, we can assign to you. Thanks in advance :)

@shinigami-777
Copy link

Hi @davidmirror-ops I would like to work on this if not taken. Should the entire section under flytectl sandbox be removed from https://docs.flyte.org/en/latest/api/flytectl/sandbox.html ?

@davidmirror-ops
Copy link
Contributor

@shinigami-777 done! Please let us know soon any questions you may have. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

7 participants