Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add LF footer, social icons, favicon and logo and instruction to run the new website #36

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -280,3 +280,4 @@ $RECYCLE.BIN/
# Docker compose config secret (ask maintainers)
secret

/venv
2 changes: 1 addition & 1 deletion .yamllint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ extends: default
rules:
document-start: disable
line-length:
max: 164
max: 250
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Binary file added docs/assets/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 18 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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)"
Expand Down Expand Up @@ -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

Expand Down
Loading