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

refactor KPtop docs #62

Merged
merged 1 commit into from
Jun 30, 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
69 changes: 69 additions & 0 deletions docs/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
layout: default
nav_order: 2
# permalink: /
# parent: Home
permalink: /commands
title: Custom Commands Docs
markdown: Kramdown
has_children: true
kramdown:
parse_block_html: true
auto_ids: true
syntax_highlighter: coderay
---

<button class="btn js-toggle-dark-mode">Switch to Dark Mode

<script>
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');

jtd.addEvent(toggleDarkMode, 'click', function(){
if (jtd.getTheme() === 'dark') {
jtd.setTheme('light');
toggleDarkMode.textContent = 'Switch to Dark Mode';
} else {
jtd.setTheme('dark');
toggleDarkMode.textContent = 'Switch to Light Mode';
}
});
</script>

# Custom Commands
{: .fs-9 }

Create monitoring dasboards on the terminal easily with a simple yaml file !

<br>

## Examples
- [pods.yml](../../examples/dashboards/pods.yml)
- [pvcs.yml](../../examples/dashboards/pvcs.yml)

<br>

---

<br>

## List commands

```bash
kptop --list-commands
```


## Run command


```bash
kptop --command <DASHBOARD-NAME>
```

<br>

---

## Command YAMl structure

To be added.
69 changes: 69 additions & 0 deletions docs/dashboards/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
layout: default
nav_order: 1
# permalink: /
# parent: Home
permalink: /dashboards
title: Custom Dashboards Docs
markdown: Kramdown
has_children: true
kramdown:
parse_block_html: true
auto_ids: true
syntax_highlighter: coderay
---

<button class="btn js-toggle-dark-mode">Switch to Dark Mode

<script>
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');

jtd.addEvent(toggleDarkMode, 'click', function(){
if (jtd.getTheme() === 'dark') {
jtd.setTheme('light');
toggleDarkMode.textContent = 'Switch to Dark Mode';
} else {
jtd.setTheme('dark');
toggleDarkMode.textContent = 'Switch to Light Mode';
}
});
</script>

# Custom Dashboards
{: .fs-9 }

Create monitoring dasboards on the terminal easily with a simple yaml file !

<br>

## Examples
- [pods.yml](../../examples/dashboards/pods.yml)
- [pvcs.yml](../../examples/dashboards/pvcs.yml)

<br>

---

<br>

## List dashboards

```bash
kptop --list-dashboards
```


## Run dashboard


```bash
kptop --dashboard <DASHBOARD-NAME>
```

<br>

---

## Dashboard YAMl structure

To be added.