1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Commit Graph

35 Commits

Author SHA1 Message Date
Paul Williams
61ec285e00 Reworked Extension Guides
Edited and reworked content in the Extension Guides Overview and the Generator and Main Extension guides.

Signed-off-by: Paul Williams <pawilliams@mirantis.com>

Update docs/extensions/guides/main-extension.md

Co-authored-by: Panu Horsmalahti <panu.horsmalahti@iki.fi>

Update docs/extensions/guides/generator.md

Co-authored-by: chh <1474479+chenhunghan@users.noreply.github.com>
Signed-off-by: Paul Williams <pawilliams@mirantis.com>
2020-12-11 14:48:34 -08:00
Jim Ehrismann
831fb80bfe
extension store guide (#1663)
* extension store guide

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* improve docs as per reviews and rereading

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* more doc tweaks

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-12-07 15:25:17 -05:00
Sebastian Malton
22a8442a89
Write up on some ways to publish extensions (#1660)
* write up on some ways to publish extensions

Signed-off-by: Sebastian Malton <sebastian@malton.name>

* tweak text

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-12-07 14:43:36 +02:00
Lauri Nevala
d3026d4dd0
Add initial KubeObjectListLayout sample (#1662)
* Add initial KubeObjectListLayout sample

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Fine tuning

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Fix typos

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>
2020-12-07 12:46:39 +02:00
Jim Ehrismann
aa508f9b0a
Status bar item and kube object menu/detail item extension guides (#1629)
* extension guides for statusBarItems, kubeObjectMenuItems, and kubeObjectDetailItems

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* address extension guide review comments

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* fix typos found in  review

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-12-04 08:38:55 -05:00
Sebastian Malton
111c518bf5
add basic usage docs for extensions (#1583)
Signed-off-by: Sebastian Malton <sebastian@malton.name>
2020-12-01 11:30:01 -05:00
Jim Ehrismann
63ead8e65a
appPreferences guide (#1584)
Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-12-01 08:57:03 -05:00
Jari Kolehmainen
2de1acde10
Tweak extensions page texts (#1550)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-12-01 11:20:59 +02:00
chh
997fb22d80
Add section for extension testing (#1576)
Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>
2020-11-30 21:58:04 +08:00
Sebastian Malton
686cb122a3
add step to verify docs on area/documentation PRs (#1528)
* add step to verify docs on area/documentation PRs

* use GH actions to run the verification

* add check if label is set to area/documentation

* fix broken links in docs with WIP files

* add generating API docs before verifying

Signed-off-by: Sebastian Malton <sebastian@malton.name>
2020-11-27 10:13:53 -05:00
Alex Andreev
168385385b
Adding links to styling samples (#1534)
Signed-off-by: Alex Andreev <alex.andreev.email@gmail.com>
2020-11-27 11:51:19 +03:00
Jim Ehrismann
238756be72
cluster feature extension guide (#1527)
* added more sample extensions to overvew list, started clusterFeatures doc

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* cluster-feature extension guide

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* resolve merge conflict, plus address review comments, tweaks

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-11-26 08:55:27 -05:00
Sebastian Malton
1547142125
Add starting point for mobx related documentaion (#1422)
* add a brief overview to our use of mobx and mark all observable fields as observable in our docs

* add to navigation

Signed-off-by: Sebastian Malton <sebastian@malton.name>
2020-11-25 14:05:58 -05:00
Sebastian Malton
c93ee4ea6d
[BREAKING]: remove deprecated routePath before GA (#1505)
Signed-off-by: Sebastian Malton <sebastian@malton.name>
2020-11-25 12:03:57 +02:00
chh
b94e523ad5
Add documentation on how to use Lens Extension Generator (#1411)
* Add generator docs

Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>

* 'Welcome' > 'You are welcome to ...'

Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>

* Add missing backslash

Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>

* Move Generator section to Extension Guides

Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>
2020-11-24 16:38:43 +02:00
Jim Ehrismann
cd4660b85b
Doc/renderer extension guide (#1476)
* lens renderer extension guide

* renderer extension guide (pages and page menus)

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-11-23 17:06:19 -05:00
Jim Ehrismann
b0b2a99372
Extension Guides documentation (#1427)
- overview
- main extension guide

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2020-11-18 09:01:42 +02:00
pauljwil
532b10e357
Reworked remaining docs (#1402)
Signed-off-by: Paul Williams <pawilliams@mirantis.com>
2020-11-17 08:48:24 +02:00
pauljwil
656797abc7
Resolved conflicts in Your First Extension, Styling, and Color Reference after rebasing from master (#1379)
Signed-off-by: Paul Williams <pawilliams@mirantis.com>
2020-11-16 11:14:33 +02:00
Jari Kolehmainen
df0f080380
Simplify pages/menus/registry extension api internal implementation (#1364)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
Co-authored-by: Roman <ixrock@gmail.com>
2020-11-13 17:04:39 +02:00
Alex Andreev
d7febf5e89
Docs: fixing typos in styling (#1363)
* Adding dashes -- before variable names

Signed-off-by: Alex Andreev <alex.andreev.email@gmail.com>

* Fixing typos

Signed-off-by: Alex Andreev <alex.andreev.email@gmail.com>
2020-11-13 15:55:49 +03:00
Stefan Cameron
dd925a87de
Update styling docs (#1339)
Building on https://github.com/lensapp/lens/pull/1267 and iterating on the docs,
re-organizing them into Layout and Theme sections.

Also adding sample code on how to detect theme changes in JavaScript.

Signed-off-by: Stefan Cameron <stefancameron@SC-MBPt13-2018.austin.rr.com>
2020-11-13 10:09:47 +03:00
Roman
faa1cef307
PageRegistration & BaseRegistry refactoring (#1334)
Signed-off-by: Roman <ixrock@gmail.com>
Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-11-12 16:29:02 +02:00
Lauri Nevala
89f575701d
Add extension development instructions for Windows users (#1350)
* Add extension development instructions for Windows users

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

Co-authored-by: steve richards <steve.james.richards@gmail.com>
2020-11-12 12:57:40 +02:00
Jari Kolehmainen
00be4aa184
Remove windowManager from extension api (#1323)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-11-11 21:55:49 +02:00
Jari Kolehmainen
469b723469
Generate extension api reference docs using library mode (#1307)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-11-11 09:02:26 +02:00
Mario Sarcher
de85229512 Generate API Reference documentation using typedocs and gh-actions
Signed-off-by: Mario Sarcher <msarcher@mirantis.com>
2020-11-10 09:36:28 +01:00
Lauri Nevala
b7fde0c6a6
Fix KubeObjectDetails example in common capabilities (#1299)
Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>
2020-11-10 09:46:50 +02:00
Alex Andreev
8d1c29ae4c
Docs: extension styling and theming (#1267)
Signed-off-by: Alex Andreev <alex.andreev.email@gmail.com>
2020-11-09 19:05:27 +02:00
Sebastian Malton
6e77e7eabb
add some overview documentation to the getting started page (#1269)
* add some overview documentation to the getting started page

Signed-off-by: Sebastian Malton <sebastian@malton.name>
2020-11-09 10:48:09 -05:00
Jari Kolehmainen
1b71106ed5
Docs: extension common capabilities (#1259)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-11-06 16:50:11 +02:00
Lauri Nevala
b5cef916a2
Docs: Extension Anatomy (#1265)
Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>
2020-11-06 16:34:48 +02:00
chh
ea155de6e4
Docs: extension testing (#1264)
Signed-off-by: Hung-Han (Henry) Chen <1474479+chenhunghan@users.noreply.github.com>
2020-11-06 16:29:43 +02:00
Jari Kolehmainen
f8ae8cc53d
Restructure docs menu (#1235)
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2020-11-05 17:30:49 +02:00
Mario Sarcher
3bc45218c1
Documentation (MKDOCS) (#1230)
Co-authored-by: Steve Richards <srichards@mirantis.com>
Co-authored-by: Mario Sarcher <msarcher@mirantis.com>
Co-authored-by: steve richards <steve.james.richards@gmail.com>
Co-authored-by: Paul Williams <pawilliams@mirantis.com>
Co-authored-by: pauljwil <pauljwil@gmail.com>
2020-11-05 16:38:56 +02:00