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

Missing documentation on Contexts #1536

Open
omar711 opened this issue Oct 12, 2023 · 3 comments
Open

Missing documentation on Contexts #1536

omar711 opened this issue Oct 12, 2023 · 3 comments
Labels
docs

Comments

@omar711
Copy link
Contributor

omar711 commented Oct 12, 2023

Where did you see the issue in our documentation?

https://docs.kurtosis.com/cli

Issue description

kurtosis context commands are missing documentation.

I've also not found anything that explains what a context is. Possibly https://docs.kurtosis.com/cloud touches on it but I'm not certain.
@omar711 omar711 added the docs label Oct 12, 2023
@omar711 omar711 mentioned this issue Oct 12, 2023
Merged
@leeederek
Copy link
Contributor

@omar711 thanks for filing this! Let me take care of this. I also notice that we don't have any docs for "portal" either - will add those as well.

github-merge-queue bot pushed a commit that referenced this issue Oct 13, 2023
@omar711
feat: rename kurtosis context "switch" to "set" (#1537)
ccff275 
## Description:
Changes the command `kurtosis context switch` to `kurtosis context set`,
to match the similar command `kurtosis cluster set`.

I've changed the cli command itself, plus the context config store.
There's also the portal manager, which I've left as switch for now, as
it extends into the kurtosis-portal project; I think we'll also need to
do that?

We're missing documentation on contexts and this cli command. I don't
know what to write for it yet so I've added
#1536

## Is this change user facing?
YES
<!-- If yes, please add the "user facing" label to the PR -->
<!-- If yes, don't forget to include docs changes where relevant -->

## References (if applicable):
#1508

---------

Co-authored-by: Omar <omar@omar>
@leeederek leeederek mentioned this issue Oct 13, 2023
Draft
@leeederek
Copy link
Contributor

Update: we have plans to remove the context concept altogether and opted to expose end users to just kurtosis cloud commands, and so the PR i've linked (#1557) will be for cloud cli commands and has no mention of contexts. I believe this addresses the pain points highlighted in this issue.

@omar711
Copy link
Contributor Author

omar711 commented Oct 16, 2023

Sounds great @leeederek

@omar711 omar711 mentioned this issue Oct 16, 2023
Closed
@leeederek leeederek removed their assignment Nov 1, 2023
@leeederek leeederek mentioned this issue Dec 5, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@omar711 @leeederek