Skip to content

Commit

Permalink
feat: for APPLAUNCHER-27 removed some documentation for now
Browse files Browse the repository at this point in the history
  • Loading branch information
Sinjhin committed Mar 13, 2024
1 parent 2568eba commit 932eacd
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions pkg/app-launcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ Rancher App Launcher Extension is a powerful tool for improved accessibility and
## How to Run

1. Clone this repository to your machine.
2. Install the npm dependencies using the command "yarn install".
3. Run the extension with the command "API=<Rancher Backend URL> yarn dev".
2. Install the npm dependencies using the command `yarn install`.
3. Run the extension locally with the command `API=<Rancher Backend URL> yarn dev`.

## Usage

Once the Rancher App Launcher Extension is installed, you can access a unified resource page from the main dashboard. This page showcases cards for each discovered service, allowing you to conveniently open the service with a simple click. The extension is designed to improve discoverability, and offer a straightforward way to navigate the complexities of multi-cluster environments.
- Once the Rancher App Launcher Extension is installed, you can access a unified resource page from the main dashboard.
- This page showcases cards for each discovered service and ingress, allowing you to conveniently open the service with a simple click.
*The extension is designed to improve discoverability, and offer a straightforward way to navigate the complexities of multi-cluster environments.*
- Global apps will show at the top as a combination of global apps defined by cluster YAML files and user-selected favorites
*\*note: global apps can be set by modifying the service's `metadata.annotations['extensions.applauncher/global-app']` to 'true'*
- Select different clusters to view the services of. Global Apps perisist across all views.
- The view can be changed with the view buttons from grid to list views.

## Contribution

Expand Down

0 comments on commit 932eacd

Please sign in to comment.