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

Update SB Aliases #258

Open
Barrow1990 opened this issue Jan 7, 2024 · 8 comments
Open

Update SB Aliases #258

Barrow1990 opened this issue Jan 7, 2024 · 8 comments

Comments

@Barrow1990
Copy link
Contributor

Update SB Aliases description under: https://docs.saltbox.dev/reference/guides/aliases/?h=

Current available options:

  • sb update
  • sb list
  • sb install
  • sb bench
  • sb recreate-venv
  • sb inventory
  • sb branch
  • sb sandbox-branch
@owine
Copy link
Collaborator

owine commented Jan 7, 2024

@saltydk do you want all of these documented?

@keldian
Copy link
Contributor

keldian commented Feb 7, 2024

I'm thinking we could use a page dedicated to sb, tags and roles since right now that info is scattered all over the docs. For instance, the new custom meta-tag stuff could be offloaded there rather than be footnotes on https://docs.saltbox.dev/saltbox/basics/install_types/. The inventory page might have less things to cover as a result and be more concise.

I can work on it if everyone's in agreement.

@owine
Copy link
Collaborator

owine commented Feb 7, 2024

Makes sense to me and timing is good with the new binary rewrite deployed

@Barrow1990
Copy link
Contributor Author

Hi, Is there an update on this?
Also do we know what sb sandbox-branch does and is this the best method for doing the following.
Contributing to Sandbox Apps

@saltydk
Copy link
Member

saltydk commented Aug 15, 2024

branch commands are only useful for when users test something we don't think is ready for the main branch.

@saltydk
Copy link
Member

saltydk commented Aug 15, 2024

Frankly, as far as I am concerned the sb tool describes what all commands do, if users need more they can ask on discord.

@Barrow1990
Copy link
Contributor Author

That's fine. Should this issue be removed then?

@saltydk
Copy link
Member

saltydk commented Aug 15, 2024

Docs could just reference running

sb --help

since that will be the most up to date descriptions of all of the commands, if something is too vague then issue belongs in the sb repo.

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

No branches or pull requests

4 participants