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.

Sign up for GitHub

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

Jump to bottom

Expose connectable help, along with their parameters, via the CLI #1188

Open
Julian opened this issue May 21, 2024 · 0 comments
Open

Expose connectable help, along with their parameters, via the CLI #1188

Julian opened this issue May 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Julian
Copy link
Member

Julian commented May 21, 2024 •
edited
Loading

We need to update the --help docs to document connectables, as well as their parameters.

Right now we only document the image connectable.

We should hide this information though in some advanced section, as it's going to be useful only to a very very small number of people so long as we only have 2 connectables (image and container).
@Julian Julian added the documentation Improvements or additions to documentation label May 21, 2024
Julian added a commit that referenced this issue May 22, 2024
@Julian
Add user-facing documentation on connectables.
e978809 
This does so for the RTD docs, but not yet for the CLI --help, which
we'll need to add later.

Refs: #1188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Julian