From a69bbffbf1383b4df363ab404b33734a47136d9c Mon Sep 17 00:00:00 2001
From: Augustin Husson <husson.augustin@gmail.com>
Date: Tue, 17 Sep 2024 11:45:42 +0200
Subject: [PATCH] add LF footer, social icons, favicon and logo and instruction
 to run the new website

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>
---
 .gitignore                     |   1 +
 .yamllint.yaml                 |   2 +-
 README.md                      |  22 ++++++++++++++++++++++
 docs/assets/images/favicon.png | Bin 0 -> 2035 bytes
 mkdocs.yml                     |  20 ++++++++++++++++++--
 5 files changed, 42 insertions(+), 3 deletions(-)
 create mode 100644 docs/assets/images/favicon.png

diff --git a/.gitignore b/.gitignore
index 7da3856..ef7506d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -280,3 +280,4 @@ $RECYCLE.BIN/
 # Docker compose config secret (ask maintainers)
 secret
 
+/venv
diff --git a/.yamllint.yaml b/.yamllint.yaml
index 977f803..f40ce4f 100644
--- a/.yamllint.yaml
+++ b/.yamllint.yaml
@@ -3,4 +3,4 @@ extends: default
 rules:
   document-start: disable
   line-length:
-    max: 164
+    max: 250
diff --git a/README.md b/README.md
index 09284ad..c86a080 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,25 @@ This repository contains everything required to start the Perses demo, the docum
 ## Instructions
 
 On the machine, just pull this repository and run `podman-compose up -d`
+
+
+### Start the website locally
+
+We recommend you to create a python virtual environment.
+
+```bash
+python3 -m env venv
+source ./venv/bin/activate
+```
+
+Then you can install de libs required to run the Perses website:
+
+```bash
+pip install -r requirements.txt
+```
+
+And finally you can run the server:
+
+```bash
+mkdocs serve -a "localhost:8080"
+```
diff --git a/docs/assets/images/favicon.png b/docs/assets/images/favicon.png
new file mode 100644
index 0000000000000000000000000000000000000000..8786b8568c8c9e03187c6459afeb9f0d50abb8ee
GIT binary patch
literal 2035
zcma)+X;c#E8pm;87^SY$XsLN;Y^>DMG_h+Av>0ZJTcT2_*_6g8uDM;@b1Tzw$&Icp
zG@_=GfGD8kU}}nJT8<+GVut%dk{Tj-alZBCp8KBjywCZ+=l{O%hyVFKcRbylb+q?s
z0{{RWm-9~EiZ0qIO?AZ%LCh5^npV_#WGn#i!_PaV<l=o`$DtJK?R*B%G-x!Z5UQc4
z;imzB=KH{{U^M_hBhSU@v`?ba5^o|}FVsX$K>CN;1KsNa$n(rR?P6uk3T>M@0A0nQ
zQ$5B*<A*)3)spWZGJ$#IiK8*vZ=C3yiB(7Y;ZN#A4TXH(#?ZK`;)nlp8Nf;^X)KAu
zxa@t+oSfT4+g>~I-6TW056vaF=35emVp_Ctl>zD7<w1k`eca_K^GD41$5$Y%-WS$w
z<Em|j(SGRo75e=JYc;GH%bu6lu5-KcT)GJpqla65A5P!(YS+ifQqW70d-X2R&7zO{
zBd~tK_3|WgFyMEU4<7#AwvlQJxnbQ!4|PRd;kIgRzFmh51ziq=%QI(u6OyR9&IoX)
zbTKg3dmXuDR9GLLjwKJBJ<Kcay+2v24OOv!;W;pNq|wMr=wgY%E=02n8@3#*lUe2(
ziH7y#IXH7e0hp>Y8s6oF*q`w#%bSLrU5N6zq0;_l)%<(XhpZg~=?X8wek64`e-<`j
zaj>|M@Wt|0iL<`s(j1d)$FsW>n1i!07RdEGumh{z6>VU;D{jTQpP&L|_a>k({a9Tq
z=Qy%gR+#?`d3R?mG%)Zu$_R;la5fPdkoCtv{X-(O>CceQ{A%vSFbaG<a&Q%;r*6jz
zoMp&@E88Pl;_ji}5!R~fN{!j!`8-U@WWef%SpI1QQc&<k#sB$IxtP+2V+W%^-z1uD
zTD6uWsH3waQvt*X;^ponVFq~vUB<l;bF%l^FG`RM#<A-~U#t!V<sL(?_pOok+U019
z@@Tsgcp)1MX`42lj2;<$Mq(|TbB-zZi=>PAPKo%dqczkyg3Dc7<@<tN{PmyQ+)JiE
zTAK8)-vx>~X(Bl%+pk%Y)zTL!11ftz0Dx*EyB8y{+q00W;A)E0jAddz=#5d|{}w`*
z?{!VYuYB%mG4IuMe2_c5akO-}fH{F!pn#P@*UNbhr6UE*nZvMj4WeWC`zH@-1U>td
z_MZ>yXnnSF@g4vax~CrbyMa;;Q#J7f|Gl3FHO#E@_FNFv<p>+xttmRiv1DX<SCL!)
ze&LNg_E1fS`?2_II<tg!+5+SI7oMj`DaD}B!#$dgPf|F<-uDbU_;A<_)%|}3q*76c
z88_av3xsk0G)(ZvkqMtiysh}--020o`aVs^%&xxYvVxh(y16cTq8GJsL~$esj-+|f
zf>`j1yYMy9`n^umlRo|6$bugH$bH(9aNMo_hT2!B<<%G-JmNnI_NQf96$t&CY~$NE
zH<yaI%e$vt6X=p8T?Fx)5CNxjNWZ*ID;LKRrFC#p>djYCS5pl(QdsA(>+waxHDnVw
z_&5nDdP+2loLZ~K6L|;AheEuOws9ma(NjtE2E?HPf9>5^i?3AymWEXQ`eVEOv3Ym+
z1oa9-65Zdg;h%WWBTvJJp}#pvN!n90|Jd13-P55{mW6N>`@T$V^EE=w0iXlmi|Ju@
z_lQc61~Dz}==IU^@!TCQQsN0`4@)gm|7H-*nR!|o(Kpo_<&*t51B*D+1LPGpt{y1s
zV6U}>I8VzuJ^h7%$g_6b9lSo6wLYyvpQ!IQ6_tBlum`3X@1U!X49vb(hTSnFm%WfK
z!#Gy|-p!lE2%SbgKdjD<Se^YT$RePEQbUKaSW&kW17iDGLJ5*#pf?thfcjz#lf((|
zlCMp0i`ROiL0G&*7GUr?+@V=Mz{)o(Fb&g-(OkjjTUQ`kyw`h2IhK5GEao>hrBBXA
zLeR`7A>%+^E7Y=NtdUaKjNWYF+dd@XD$&gtf>pb#JeB|W3J2d@lnTfv%VPN8B=Wy3
zmz2KAE6OPr3ff96Z@@14N`_`KxKc1{$%cw}+v77pDf(4`8z3mu0Gkpca}%o`1e4qw
z#Bo@jR53KC{sN=opwTv@q>kBuz>Xy*rsOk|d$|P_v6*%<N||Jk0h&Zx#higx<&%=%
zda!HzHQInHgn-0@UPgSgS8M0Q8AYYKQ4<d1Jn;5#%A*TYpHfPMppd$~u5+P^pk$<(
z()nv9&@H(2U81R|YZg<kH4mFyxplxcN1>0><IL&}vxihn6~k2+jO#gI7dXc}->=?g
zoY1i`u?exx>@V?u;WlP&ojJbvIy2Hs2=GWM8~g4!?vRl{{;=%gXt?68<DHhT#dm%i
z;j6<u!JYYw&`=_0p;Pn1O19jBuuOZ|U~`zg?gDwF2J=j|x^<E|g<-31n@xwQ_iCk4
zQFxLVB|cyhqzbdS9VZZCQ3IP`1#=V1Q<W~J&S^HNv{>5AB&0oGe^AMmf?Rw(fBT(A
zt<;WlJ=t(l=o8{+fvGJ;^L3&7HgFM`q?$`*dR6FVX+U5Ty{}QcY=(pGCC@9%Ot2@b
tQZb(>bj0=ukCN>BGw_=X|A*-GmxFfsuO@%q<A>O>xtw!%YC3Z@^S^PE+4%qf

literal 0
HcmV?d00001

diff --git a/mkdocs.yml b/mkdocs.yml
index 1603a12..4705b4e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,9 +1,10 @@
 site_name: Perses
 site_url: "https://perses.dev"
-repo_name: "Perses on GitHub"
+repo_name: "perses/perses"
 repo_url: "https://github.com/perses/perses"
 theme:
   name: material
+  logo: assets/images/favicon.png
   palette:
     # Palette toggle for automatic mode
     - media: "(prefers-color-scheme)"
@@ -54,8 +55,23 @@ extra_css:
 # extra_javascript:
 #   - 'js/main.js'
 
-# Enable versioning
+copyright: |
+  The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href='https://www.linuxfoundation.org/trademark-usage/'>Trademark Usage</a>
+
 extra:
+  # used to remove the text "made with material for mkdocs: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice"
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/perses
+    - icon: fontawesome/brands/x-twitter
+      link: https://twitter.com/PersesDev
+    - icon: fontawesome/brands/linkedin
+      link: https://linkedin.com/company/persesdev
+    - icon: fontawesome/brands/slack
+      link: https://cloud-native.slack.com/messages/C07KQR95WBE
+    - icon: fontawesome/brands/docker
+      link: https://hub.docker.com/r/persesdev/perses
   version:
     provider: mike