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

New panel for Docker context #1844

Closed
karolz-ms opened this issue Apr 9, 2020 · 9 comments · Fixed by #1916
Closed

New panel for Docker context #1844

karolz-ms opened this issue Apr 9, 2020 · 9 comments · Fixed by #1916
Assignees
Milestone

Comments

@karolz-ms
Copy link
Contributor

karolz-ms commented Apr 9, 2020

Panel that shows Docker contexts and is a sibling of containers, networks etc.
This panel should be at the bottom and collapsed by default
Current context in use is clearly marked (bolded)
Displays context description on hover.
Hookup the use, delete, and inspect context commands to context menu items named the same.

Later this year this panel will also show all shared contexts a user has in DockerHub, assuming they are signed into DockerHub.

@karolz-ms karolz-ms added this to the 1.2.0 milestone Apr 9, 2020
@karolz-ms karolz-ms self-assigned this Apr 9, 2020
@bwateratmsft
Copy link
Contributor

bwateratmsft commented Apr 9, 2020

One thing about the hover text--it may have accessibility impact, we would want to validate that.

For example, right now the hover text is equivalent to the label. Would changing the hover text to a context description cause a screen reader to read the description, but not the label? (I don't know but it might)

@karolz-ms
Copy link
Contributor Author

Good point.

The hover thing is a nice-to-have; if we find spending a lot of time on this, we can just drop it.

@bwateratmsft
Copy link
Contributor

This is interesting: https://code.visualstudio.com/api/references/vscode-api#TreeItem

They have a description property which is rendered less prominently--probably similar to quick pick items' description/detail--that might be a good place for it. Or, it might be a good place for the "currently selected" label.

@BigMorty
Copy link
Member

BigMorty commented Apr 22, 2020

After our design session today, here is what the current thinking is:

  • Panel will be named "CONTEXTS"
  • Panel will be above the Help and Feedback panel
  • Panel will collapsed by default (if VS Code offers this)
  • Panel will have Gear, Refresh, and Help icons
  • Help icon should take user to new help doc that discusses Contexts
  • All local contexts will be displayed in flat list (no parent item)
  • Items will show Name & Description by default - Docker endpoint will be the other available field
  • Items will not have a icon unless it is the active icon and then the plug icon will be displayed
  • Gear icon will show Label, Description, Reset settings
  • Context menu items will be Inspect & Use in first section and Remove in the second section

@karolz-ms
Copy link
Contributor Author

Thanks @BigMorty! Two questions:

Help icon should take user to new help doc that discusses Contexts

Do we really need to have a new documentation topic for contexts? Can we just link to Docker context doc instead? We really just expose basic operations around contexts, so having a VSCode docs for them seems like a waste of electrons.

Gear icon will show Label, Description, Reset settings

I assume this is to the user can list context by Description instead of by Name? (in Docker lingo the context has "Name", not "Label"). Do we really need this Gear icon and associated functionality? Can we just populate the item description with context Description, like @bwateratmsft suggested above?

@bwateratmsft
Copy link
Contributor

I agree with @karolz-ms, I feel like nobody would actually use the gear to change the label / description. I can't honestly see why anybody would want something other than context name as label, context description as description.

@ravipal
Copy link
Contributor

ravipal commented Apr 22, 2020

Agree on doc - we can reuse Docker context doc.

Agree that most of the users will use the default. But having a settings will help user for those want to see 'docker endpoint' in the tree view. Besides this functionality is provided in base class so doesn't require much effort to add this functionality.

@BigMorty
Copy link
Member

I can go either way on the gear/settings. Regarding the help link, I feel like it should go to a Docker Explorer specific page that discusses Contexts. But you are right we probably don't need an entire page for Contexts. Let me think on this a bit and get back to you. you can have it do the standard behavior like the other panels do for now.

@bwateratmsft
Copy link
Contributor

If our UI is complicated enough that it needs a doc page, I think we've made a mistake. The UI should be self-explanatory enough that the Docker page is sufficient.

@vscodebot vscodebot bot locked and limited conversation to collaborators Jun 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants