Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Gardner <[email protected]>
  • Loading branch information
agardnerIT committed Sep 14, 2024
1 parent e3ae23b commit 8336df6
Show file tree
Hide file tree
Showing 4 changed files with 155 additions and 0 deletions.
3 changes: 3 additions & 0 deletions css/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
h1, h2, h3 {
color: #ffffff !important;
}
43 changes: 43 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
hide:
- navigation
- toc
- search
- path
---

<center>
![perses logo](https://perses.dev/images/perses_logo_cropped.png)

# Open-source Apache-2.0 Licensed

## An open specification for dashboards. The open dashboard tool for Prometheus and other data sources.
</center>

<div class="grid cards" markdown>

- ## GitOps Native

---

Facilitates a seamless "dashboards as code" workflow by introducing an innovative and precisely defined dashboard definition model.

[:octicons-arrow-right-24: Link here](#)

- ## Extensible

---

Perses, with its plugin-based architecture, offers effortless extension and reuse of plugins across different projects.

[:octicons-arrow-right-24: Link here](#)

- ## Static Validation

---

Perses supports hassle-free dashboard-as-code usage with built-in static validation. Validate your dashboard in CI/CD using the Perses CLI (percli).

[:octicons-arrow-right-24: Link here](#)

</div>
106 changes: 106 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
site_name: Perses
site_url: "https://perses.dev"
repo_name: "Perses on GitHub"
repo_url: "https://github.com/perses/perses"
theme:
name: material
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: black
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: black
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: black
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.tabs
- content.code.copy
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: "#"
- admonition
extra_css:
- 'css/style.css'
# extra_javascript:
# - 'js/main.js'

# Enable versioning
extra:
version:
provider: mike


# Multi repo support
plugins:
- multirepo:
# (optional) tells multirepo to cleanup the temporary directory after site is built.
cleanup: true
# if set the docs directory will not be removed when importing docs.
# When using this with a nav section in an imported repo you must keep the
# docs directory in the path (e.g., docs/path/to/file.md).
keep_docs_dir: true
nav_repos:
- name: perses
import_url: https://github.com/perses/perses?branch=main
# forward slash is needed in '/README.md' so that only the README.md in the root
# directory is imported and not all README.md files.
imports: [docs/*]
nav:
- 'Home': 'index.md'
- 'Docs':
- 'Introduction': 'perses/docs/prologue/introduction.md'

Check failure on line 81 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

81:5 [indentation] wrong indentation: expected 6 but found 4
- 'API': 'perses/docs/api/README.md'
- 'Dashboard as Code':
- 'CUE': 'perses/docs/dac/cue'

Check failure on line 84 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

84:7 [indentation] wrong indentation: expected 8 but found 6
- 'Go': 'perses/docs/dac/go'
- 'Design Docs':
- 'Authentication': 'perses/docs/design-docs/authentication.md'

Check failure on line 87 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

87:7 [indentation] wrong indentation: expected 8 but found 6
- 'Authorization': 'perses/docs/design-docs/authorization.md'
- 'Perses on Kubernetes': 'perses/docs/design-docs/kubernetes.md'
- 'Plugins':
- 'Introduction': 'perses/docs/plugins/introduction.md'

Check failure on line 91 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

91:7 [indentation] wrong indentation: expected 8 but found 6
- 'CUE in Perses': 'perses/docs/plugins/cue.md'
- 'Panel Plugin': 'perses/docs/plugins/panels.md'
- 'Prometheus Plugins': 'perses/docs/plugins/prometheus.md'
- 'Tooling':
- 'Perses CLI (percli)': 'perses/docs/tooling/cli.md'

Check failure on line 96 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

96:7 [indentation] wrong indentation: expected 8 but found 6
- 'User Guides':
- 'Configuration': 'perses/docs/user-guides/configuration.md'

Check failure on line 98 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

98:7 [indentation] wrong indentation: expected 8 but found 6
- 'Dashboards as Code': 'perses/docs/user-guides/dashboard-as-code.md'
- 'Embedding Perses Panels': 'perses/docs/user-guides/embedding-panels.md'
- 'Installation':
- 'Installing Perses from Source': 'perses/docs/user-guides/installing-perses-from-source.md'

Check failure on line 102 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

102:9 [indentation] wrong indentation: expected 10 but found 8
- 'Installing Perses in a Container': 'perses/docs/user-guides/installing-perses-in-a-container.md'
- 'OAuth Helper': 'perses/docs/user-guides/oauth-configuration-helpers.md'
- 'Provisioning': 'perses/docs/user-guides/provisioning.md'
- Demo: 'https://demo.perses.dev'

Check failure on line 106 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

106:36 [new-line-at-end-of-file] no new line character at the end of file
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs-multirepo-plugin
mkdocs-material == 9.5.34
mike == 2.1.3

0 comments on commit 8336df6

Please sign in to comment.