add LF footer, social icons, favicon and logo and instruction to run …

…the new website

Signed-off-by: Augustin Husson <[email protected]>

.gitignore

@@ -280,3 +280,4 @@ $RECYCLE.BIN/
 # Docker compose config secret (ask maintainers)
 secret
 
+/venv

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"
+```

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