Skip to content

Commit

Permalink
Updated READMEs
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Richards <srichards@mirantis.com>
  • Loading branch information
stevejr committed Nov 5, 2020
1 parent 58402bd commit cd27218
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions helloworld-sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,44 @@ Simple Lens extension that adds "Hello World" page to a cluster menu.

## Install

First you will need to clone the [Lens Extension samples](https://github.com/lensapp/lens-extension-samples) repository to your local machine:

```sh
git clone https://github.com/lensapp/lens-extension-samples.git
```

Next you need to create a symlink from the directory that Lens will monitor for user installed extensions to the sample extension, in this case **helloworld-sample**:

```sh
mkdir -p ~/.k8slens/extensions
cd ~/.k8slens/extensions
ln -s <lens-extension-samples directory>/helloworld-sample helloworld-sample
git clone https://github.com/lensapp/lens-extension-samples.git
ln -s $(pwd)/lens-extension-samples/helloworld-sample ~/.k8slens/extensions/helloworld-sample
```

## Build

To build the extension you can use `make` or run the `npm` commands manually:

```sh
cd <lens-extension-samples directory>/helloworld-sample
cd lens-extension-samples/helloworld-sample
make build
```

OR

```sh
cd <lens-extension-samples directory>/helloworld-sample
cd lens-extension-samples/helloworld-sample
npm install
npm run build
```

If you want to watch for any source code changes and automatically rebuild the extension you can use:

```sh
cd <lens-extension-samples directory>/helloworld-sample
cd lens-extension-samples/helloworld-sample
npm run dev
```

## Test

Open Lens application and navigate to a cluster. You should see "Hello World" in a menu.

## Uninstall

```sh
rm ~/.k8slens/extensions/helloworld-sample
```

Restart Lens application.

0 comments on commit cd27218

Please sign in to comment.