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

Add Containers Page #305

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Add Containers Page #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09073cd
Containers section added to the user interface dropdown. Description …
sunilarjun Oct 18, 2023
739d891
Updating the containers page after review items.
sunilarjun Oct 20, 2023
d021eba
Updating actions section after review.
sunilarjun Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/img/Containers_Example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 61 additions & 0 deletions docs/ui/containers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
sidebar_label: Containers
title: Containers
---

<head>
<link rel="canonical" href="https://docs.rancherdesktop.io/ui/containers"/>
</head>

import TabsConstants from '@site/core/TabsConstants';

<!--- Insert S3 Image Here Once Uploaded -->
<Tabs groupId="os" defaultValue={TabsConstants.defaultOs}>
<TabItem value="Windows">

Windows_Image_TBD

</TabItem>
<TabItem value="macOS">

![Containers_Example](../img/Containers_Example.png)

</TabItem>
<TabItem value="Linux">

Linux_Image_TBD

</TabItem>
</Tabs>

The **Containers** tab offers quick access to manage containers and view key information such as:

- `State`:
The container state(s) will be listed in this field, and by default running containers are presented first.
- `Name`:
The container name(s) will be listed in this field and can be sorted.
- `Image`:
All image names will be listed in this field and can be sorted.
- `Port(s)`:
Ports are listed in this field and can be clicked for quick access to a localhost port.
- `Started`:
Container start-up times will be listed in this field and can be sorted.

The listed information can be sorted in ascending or descending order. Containers can also be filtered with input text in the `Filter` field located at the top right. Bulk selection is available for managing multiple instances at once.

### Container Management

The buttons located at the top of the page will be highlighted when a container is selected and depend on the container's state.

Bulk selection and actions can also be performed on instances with the same state.

The following actions are available:

- `Stop`:
You can terminate container instances using the `Stop` button.
- `Start`:
You can initiate container instances using the `Start` button.
- `Delete`:
You can delete container instances from your system entirely by using the `Delete` button.
- `⋮`:
This button is located on the right side of the tab view. You can start, stop, or delete container instances depending on their state using the `⋮` button.
1 change: 1 addition & 0 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const sidebars = {
label: 'User Interface',
items: [
"ui/general",
"ui/containers",
"ui/port-forwarding",
"ui/images",
"ui/troubleshooting",
Expand Down