From 3f3771cef9659245472039736dd8b1b882318480 Mon Sep 17 00:00:00 2001 From: Mario Sarcher Date: Wed, 28 Oct 2020 10:01:34 +0100 Subject: [PATCH] Add structure draft for Setup and Extensions --- .../get-started/your-first-extension.md} | 0 .../overview.md} | 0 docs/index.md | 4 +-- docs/setup/images/snap-store.png | Bin 0 -> 3345 bytes docs/setup/linux.md | 19 +++++++++++++ docs/setup/macos.md | 9 ++++++ docs/setup/network.md | 8 ++++++ docs/setup/overview.md | 21 ++++++++++++++ docs/setup/windows.md | 7 +++++ docs/supporting/requirements.md | 26 ++++++++++++++++++ mkdocs.yml | 23 ++++++++++++++-- 11 files changed, 113 insertions(+), 4 deletions(-) rename docs/{your_first_extension.md => extensions/get-started/your-first-extension.md} (100%) rename docs/{extensions_overview.md => extensions/overview.md} (100%) create mode 100644 docs/setup/images/snap-store.png create mode 100644 docs/setup/linux.md create mode 100644 docs/setup/macos.md create mode 100644 docs/setup/network.md create mode 100644 docs/setup/overview.md create mode 100644 docs/setup/windows.md create mode 100644 docs/supporting/requirements.md diff --git a/docs/your_first_extension.md b/docs/extensions/get-started/your-first-extension.md similarity index 100% rename from docs/your_first_extension.md rename to docs/extensions/get-started/your-first-extension.md diff --git a/docs/extensions_overview.md b/docs/extensions/overview.md similarity index 100% rename from docs/extensions_overview.md rename to docs/extensions/overview.md diff --git a/docs/index.md b/docs/index.md index e978e1716d..6c6351f7f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,10 +18,10 @@ Lens is the most powerful IDE for people who need to deal with Kubernetes cluste To get the most out of Lens, start by reviewing a few introductory topics: -[Extension API](https://docs.k8slens.dev) - Learn how to write a Lens extension. +[Extension API](/extensions/overview/) - Learn how to write a Lens extension. ... ## Downloads -[Download Lens IDE](https://github.com/lensapp/lens/releases/tag/v3.6.7) - Quickly find the appropriate install for your platform (Windows, macOS and Linux) \ No newline at end of file +[Download Lens IDE](https://github.com/lensapp/lens/releases) - Quickly find the appropriate install for your platform (Windows, macOS and Linux) \ No newline at end of file diff --git a/docs/setup/images/snap-store.png b/docs/setup/images/snap-store.png new file mode 100644 index 0000000000000000000000000000000000000000..5e652132c35ab9cd17261c1fde48b9fc8cd02881 GIT binary patch literal 3345 zcmV+s4es)ZP)GXgb&2= z;#~MGrPQ|&;??&(i2ge%2*zZQF*XX&AN%(lo_+o;Z#J^E_i&7F^ebD2hJL z)pd=1-+$OM2PQk3C=CCaIBUdN#>v`VR!mF`f9uepLwv(!>HG2HM@2?P=IOY1?AW2vqet6dX9n!bwS46h zQd^};l`8N9I(F=s_V3?M21{2akbQ%Kf>MCZf@svJ5hiD6=M?wUuU}t2K0YScix)4( zPhnwUDg2zAoW#|>eS6yF>+7r1rAyi8GP!T9<4iK}kix|Tk}h7Hr>$B(sU%^E#>_6(_Fg8lB@JMG-L6LZj}yLRou z*980W<;(bK#*7&${8$iN`}XalU2WU8CA;g*n>X6HaijL`-HVg~WL z!NSz_>(}uoRy}|IoZSRpeg6DeZQ8U+6Kw9`naCys>>D?3Xw#-mx_9p${hI#0di7%b z%mdHR)TvX83D_2J4?VaTQ@0i472c((+$wn$n87q{+EhP({&dJpXis#vx3{;xe*G$c ze}6tFQ|ZHp4~)%PidcYcB}ELdlS?0bxhJ{b?c29y%scS{q0v784jD3pzg4eZJ;r2Y zc``8VnU*3R9v=Gs{W}FEF|t6|g=kaFnl))t`SRt98Q2zZV?z!sQiplNRkvxB$~xum z#E=F5{P{yhOz}CHsY#P2wCl%@A3Ad62&Uu5kBh5f#fo_eHjo+5<$nWMvaJKyjD^eC zL5TC*xpP_4*bg5*WDXP>8miyFf1C4waRGg?E*_(LwghSi8?T2Ah#z?dMFDxLRw z9GG}v=*+ahrud_< zRjpc;|IyjHaN&Z(bGL8buCZgsrVI9+J9n4|a~B8?4^KW1#ATm~7;sxz|LwE$LyuEH z@d7Eb9Kd#QanbA7uhpYR52MZ4ekrbKOxGt>e|Yn!8R!RngDpe(74YXSpoLMdl3%2vD_Z)f|dRBTJ@nwoQRaX8&jZ^oi~@ z`p%-EvvW)W05dVM+hj(*F&Fk1G+B@(CfH3P`KkM|qUXzX`I<1{;g%+a}{+r?R#)2g}2$ ztcLoz=|Ms@6YK+a*3M_M!8S5?rokS(Z-M;6>&n!MB}=MBMQ5G*Ux$a=Sv$YY2HO&D z3$TIOKcb#>aq3xK1AP8t=PsJ$c9JN7f1PD!W@d&zGqahQnVFfHnc-@mmybRzlh(i9 z$O&1a?vc9P+wz89L>Xp8ReF_`mHATd@6iC&ttNH>awB$eQg_zqDTLUBvp_;Zm`~V_ z5GkS=4|)@mo;Y!0BWo&64#JxRU0b$nk%Y-gdW8nX`DhK3bw3Z!Y9Y=+qcg+QZ43|$hn_>)6Gc#A2@J8NuNnuJz{&P z*Vaz$w{etdeD??5*Y%ldAmP`){@WY~dpRM! z)m^vL(MF9Ll>}_8$T5o&TQp(t;K9nW8YNl7hY#;t0siurzpzIA&ZU8V>Zzw1R*asR zLXWTs)Lk|sHqq0w&pyi{lFV8q5Ign;h5E|E1@`aXpM3I@pDavlD}~i2-O}fKhUm9d z%Oo`>1ZMG^G~{u7l(Yq$LvY2{H@?JMah%mL41!h5*jcSub#h*qH*a2bh)sh%XzT2I zNqutlU9x}oe?saICt3OevFsv`-?bw4ojZ5>{Z91_B_B+iHm%SzkiZ6ru=0rglb`&g z-+5Gk0h4Q>`yi4^ob<|q?5^F3kBz_qlP~*wga#`H(NzwyP4cEIO+0hnCSHX3_H>-b=5Et&pHnq|P=2 zt&kuf0#cONK{nPjYkhpPq$$c1+lmq|zU{s~^2j49a$-Zu&n-o4;{b{sT2(56F)c%E zzH?C+i=Gnuo$r0OQm{T!f903eB6WJ%7T*TdBSneLl4ObfzW2SaQLzGwWLctz9(qWH zjtGj{%65ny7EL8jCw=>3BggHwPJB$RWgMCk{##O06p+Ut- zogG-qv~X3s#P&fPKps^$*>nEzhd;DM>{Y8)C2;%p?T-7(UC3Hhp+Sgx%e;2&+O>gl z0g=jAT33qLCVhkq8HdUyXx{Uo_a~!|uJ|vhABxagb(<_*5V8}CEj$LSTl}m;V%wC3 z3&CISxUVJ$r0Xpupa8-Bzg2(j6Y_EaU;p~oBjhL4S%%m`im~6Z!LKf{9~%2gl}K$V z_w}XRP!Zn~p}{8(z5*u+PLDFuLg4$3b7Wl@8&0TKfL*Hpc0%^TS{5A^Wvn8=Xh)$ZC%ix(Z zL~Pll<^vK!+znRP-~JClzI3s$R6kM&xo_OK!L1;9O($Gf;>ZkoHom#6u7pjDRg7V2 zVk;o_>9v5b1;{nHzNFSa{_zh9o!$}qiD`qXLh48Z(`ht|R2VQsk3sK<*zqDIgIqTU zHkXn$xy0rkn0y(DDRp9@zWUfD4TopW18Yd#m;JP`COj#oABbd2R?op*5)aR&(~&%^ zeLKXC#Ftfz^dJKh(>v)6u|NE|PgdEd7U&nHu*oy~g}e-A*CrI}#U&x^_bt4%o6*e2 zW=S2-MRI-{;veTAk@U4l0zwEwTD=C0@qg`WUlYagypC@*iCo`!BJX|A6idVyJ8qQ~ z#k2Ly$F^xKetg}EMn&pYfB3y7cHL@X*Tk-gUAHb)y@V#Bh{UvR|7n*FY5;_RD2O7u zKH4v(Sxw+z&!B_m9iD(m#@JwNj19&HV}r55*kEi99(&H&Cq+S$zN+e3YxNl8{X0m~ bd++-LifQ#ekO&T600000NkvXXu0mjfq0*o! literal 0 HcmV?d00001 diff --git a/docs/setup/linux.md b/docs/setup/linux.md new file mode 100644 index 0000000000..252ad26899 --- /dev/null +++ b/docs/setup/linux.md @@ -0,0 +1,19 @@ +# Lens on Linux + +## Installation + +See the [Download Lens](https://github.com/lensapp/lens/releases) page for a complete list of available installation options. + + + +### Snap + +Lens is officially distributed as a Snap package in the [Snap Store](https://snapcraft.io/store): + +[![Get it from the Snap Store](images/snap-store.png)](https://snapcraft.io/kontena-lens) + +You can install it by running: + +```bash +sudo snap install kontena-lens --classic +``` \ No newline at end of file diff --git a/docs/setup/macos.md b/docs/setup/macos.md new file mode 100644 index 0000000000..e411c8f54a --- /dev/null +++ b/docs/setup/macos.md @@ -0,0 +1,9 @@ +# Lens on macOS + +## Installation + +1. [Download Lens](https://github.com/lensapp/lens/releases) for macOS. +2. Open the browser's download list and locate the downloaded archive. +3. Select the 'magnifying glass' icon to open the archive in Finder. +4. Double-click `Lens-{version}.dmg` and drag `Lens.app` to the `Applications` folder, making it available in the macOS Launchpad. +5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing **Options**, **Keep in Dock**. \ No newline at end of file diff --git a/docs/setup/network.md b/docs/setup/network.md new file mode 100644 index 0000000000..b31aea55a2 --- /dev/null +++ b/docs/setup/network.md @@ -0,0 +1,8 @@ +# Network Connections in Lens + +Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium. + + +## Proxy server support + +... diff --git a/docs/setup/overview.md b/docs/setup/overview.md new file mode 100644 index 0000000000..f8f929843e --- /dev/null +++ b/docs/setup/overview.md @@ -0,0 +1,21 @@ +# Setting up Lens + +Getting up and running with Lens is quick and easy. It is a small download so you can install in a matter of minutes and give Lens a try. + + +## Cross platform + +Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis which runs on the macOS, Linux, and Windows operating systems. + +Follow the platform-specific guides below: + +* [Linux](/setup/linux/) +* [macOS](/setup/macos/) +* [Windows](/setup/windows/) + +Lens is lightweight and should run on most available hardware and platform versions. You can review the [System Requirements](/supporting/requirements/) to check if your computer configuration is supported. + + +## Update cadence + +... \ No newline at end of file diff --git a/docs/setup/windows.md b/docs/setup/windows.md new file mode 100644 index 0000000000..f804eeda3d --- /dev/null +++ b/docs/setup/windows.md @@ -0,0 +1,7 @@ +# Lens on Windows + +## Installation + +1. Download the [Lens installer](https://github.com/lensapp/lens/releases) for Windows. +2. Once it is downloaded, run the installer `Lens-Setup-{version}.exe`. This will only take a minute. +3. By default, Lens is installed under `C:\users\{username}\AppData\Local\Programs\Lens`. \ No newline at end of file diff --git a/docs/supporting/requirements.md b/docs/supporting/requirements.md new file mode 100644 index 0000000000..6eb929a3b3 --- /dev/null +++ b/docs/supporting/requirements.md @@ -0,0 +1,26 @@ +# Requirements for Lens + +## Hardware + +Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. + +We recommend: + +* 2 GHz or faster processor +* 1 GB of RAM + +## Platforms + +Lens has been tested on the following platforms: + +* OS X +* Windows +* Linux + +### Additional Windows requirements + +... + +### Additional Linux requirements + +... diff --git a/mkdocs.yml b/mkdocs.yml index e7014ff400..905d7b44a0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,8 +9,27 @@ copyright: Copyright © 2020 Mirantis Inc.