Skip to content
Open
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
3 changes: 2 additions & 1 deletion .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
cache: 'npm'
cache-dependency-path: 'opsimate-docs/package-lock.json'

Expand Down Expand Up @@ -71,3 +71,4 @@ jobs:
echo "## Link Check Passed ✅" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "All documentation links are valid!" >> $GITHUB_STEP_SUMMARY

Binary file modified opsimate-docs/.gitignore
Binary file not shown.
45 changes: 45 additions & 0 deletions opsimate-docs/docs/alerts/tv-mode-view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: TV Mode View
sidebar_position: 4
---

# TV Mode View

The **TV Mode** view is the simplest way to see the alert status of your organization at a glance.

It is designed for **wall-mounted screens**, NOC rooms, and managers who want to understand
"what is the status of our systems right now?" in a single look.

## Why TV Mode

- Show the current alert situation on a dedicated screen
- Give managers and teams a clear, shared view of system health
- Reduce the need to click around dashboards during incidents

## Views in TV Mode

There are **two main views** available in TV Mode:

### 1. Simple Grid View

A clean grid that focuses on the most important information:

- List of active alerts in a compact table-like layout
- Key fields only (service, status, severity, source, time since started)
- Optimized for readability from a distance on large screens

Use this view when you want a straightforward overview that anyone can understand quickly.

### 2. Map View (Beta)

A **beta** visualization that shows alerts on a map-like layout:

- Visual clusters of alerts to highlight problem areas
- Ability to **group alerts** by different dimensions (for example service, environment, or region)
- Quickly see where issues are concentrated and how they relate to each other

Use this view when you want to explore patterns and relationships between alerts,
while still keeping a screen-friendly presentation.

TV Mode is ideal for always-on displays and shared spaces, so everyone can see at a glance
**how your organization is doing right now**.
122 changes: 122 additions & 0 deletions opsimate-docs/docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
title: Contributing Guide
sidebar_position: 1
---

# Contributing to OpsiMate

We welcome contributions to the OpsiMate documentation. Whether you are fixing typos, adding new guides, or improving existing content, your contributions help make OpsiMate better for everyone.

## Add Documentation

To contribute new documentation to OpsiMate, follow these steps:

1. **Identify your audience and purpose**
Consider who will read your content and what they need to know. This will guide the scope, depth, and style of your contribution.

2. **Select a content type**
- **Concepts**: Explain key OpsiMate principles, features, or workflows. Link to related guides when needed.
- **Guides**: Provide step-by-step instructions for a task, such as setting up alerts or configuring pipelines.
- **Setup pages**: Focus on installing, configuring, and deploying OpsiMate.
- **Reference pages**: Detailed technical information, like API references or configuration parameters.
- **FAQs**: Quick answers to common questions.

3. **Plan your file structure**
- All files are written in **Markdown or MDX**.
- Use lowercase, hyphen-separated filenames (e.g., `external-auth.md`).
- Add front matter at the top of each file:

```yaml
---
title: Your Page Title
sidebar_label: Your Page Title
---
```
4. **Write your content**

Follow the OpsiMate style guide (see below) for language, tone, and formatting. Use Docusaurus MDX components for rich content, for example:

```mdx
import Callout from '@site/src/components/Callout';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Callout type="info">
This is an important note.
</Callout>
```
Comment on lines +40 to +47
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

find . -type f -name "*Callout*" | head -20

Repository: OpsiMate/documentation

Length of output: 48


🏁 Script executed:

fd -t f "Callout" --extension jsx --extension tsx --extension js --extension ts 2>/dev/null | head -20

Repository: OpsiMate/documentation

Length of output: 48


🏁 Script executed:

rg "Callout" --type jsx --type tsx --type js --type md -A 2 -B 2 2>/dev/null | head -50

Repository: OpsiMate/documentation

Length of output: 48


🏁 Script executed:

find src/components -type f 2>/dev/null | head -20

Repository: OpsiMate/documentation

Length of output: 48


🏁 Script executed:

ls -la src/ 2>/dev/null || echo "src directory not found"

Repository: OpsiMate/documentation

Length of output: 89


🏁 Script executed:

git ls-files | grep -i "component" | head -20

Repository: OpsiMate/documentation

Length of output: 206


🏁 Script executed:

ls -la opsimate-docs/src/components/

Repository: OpsiMate/documentation

Length of output: 378


🏁 Script executed:

rg "Callout" opsimate-docs/ 2>/dev/null

Repository: OpsiMate/documentation

Length of output: 365


Remove or replace the non-existent Callout component.

The import statement import Callout from '@site/src/components/Callout'; references a component that does not exist in opsimate-docs/src/components/. The only available components are CookieConsent and GoogleAnalytics. Contributors following this example will encounter a runtime error. Either create the Callout component or replace the example with code using an existing component or native HTML.

🤖 Prompt for AI Agents
In `@opsimate-docs/docs/contributing/index.md` around lines 40 - 47, The example
imports and uses a non-existent Callout component (import Callout from
'@site/src/components/Callout' and the <Callout>...</Callout> usage); remove
that import and either replace the JSX with an existing component such as
CookieConsent or GoogleAnalytics (update/add the appropriate import) or convert
the example to native HTML (e.g., a blockquote/div with a descriptive class) so
the example runs without a missing-component runtime error.

## Preview and Build Locally

Before submitting a contribution, preview your changes locally to ensure everything looks correct.
**Using npm**
```bash
npm install
npm run build
npm run dev
```
- The documentation will be available at http://localhost:3000

**Using Docker**
You can also use Docker for a clean, reproducible environment:
1. Build the Docker image:
```bash
cd OpsiMate-docs
docker build -t OpsiMate-docs .
```
2. Run the container:
```bash
docker run -p 3000:3000 --env-file .env OpsiMate-docs
```
- The documentation will be accessible at http://localhost:3000.

## Audience and Intended Use

Effective documentation starts with understanding your audience:

- **Task-focused**: Provide steps for completing a task.
- **Concept-focused**: Explain prerequisites or conceptual information before the task.
- **Decision-making**: Provide the context and options to help users choose the correct approach.
- **Complex features**: Use diagrams or visual aids rather than long text explanations.

## Style Guide

Follow these guidelines when writing content:

- **Language**: English only.
- **Sentence case** for body text.
- **Title case** for front matter titles.
- **Simple, present tense**.
- **Active voice**.
- Avoid “I” or “we”; address the user in the second person.
- Use **callouts** for warnings, notes, or tips.
- Clearly mark experimental or beta features.

## Docusaurus Components and Tools

OpsiMate uses Docusaurus MDX components for rich content:

- **Tabs**: Show multiple options in tabbed content.
- **Callouts**: Highlight important information.
- **Code blocks**: Syntax-highlighted examples.
- **Links**: Use relative linking between docs pages.

Refer to existing OpsiMate docs for examples of MDX usage.

## Support and Community

If you need help contributing or have questions:

- **[Documentation](https://OpsiMate.vercel.app/)** – Comprehensive guides and API references.
- **[GitHub Issues](https://github.com/OpsiMate/documentation/issues)** – Bug reports and feature requests.
- **[Slack Community](https://OpsiMate.slack.com/ssb/redirect)** – Join discussions and get help.
- **[Website](https://www.OpsiMate.com/)** – Learn more about OpsiMate.

## Review Process

All contributions are reviewed by OpsiMate documentation maintainers to ensure clarity, accuracy, and consistency. Once reviewed and approved, your changes will be merged and appear on the documentation site.

## Generated Docs

Some content, like API references, may be automatically generated. Check the repository for details on contributing to these sections.


72 changes: 0 additions & 72 deletions opsimate-docs/docs/core-features.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,16 @@ A saved dashboard includes:
- **Tags** (for organization and filtering)

<div style={{textAlign: 'center', margin: '30px 0'}}>
<img src="/img/saved-dashboards.png" alt="Saved Dashboards" style={{width: '900px', maxWidth: '100%', height: 'auto', borderRadius: '8px', boxShadow: '0 4px 12px rgba(0,0,0,0.15)'}} />
<p style={{fontSize: '14px', color: '#666', marginTop: '10px', fontStyle: 'italic'}}>Saved Dashboards page with favorites, tags, search, and actions</p>
<img
src="/img/saved-dashboards.png"
alt="Saved Dashboards"
style={{width: '900px', maxWidth: '100%', height: 'auto', borderRadius: '8px', boxShadow: '0 4px 12px rgba(0,0,0,0.15)'}}
/>
<p style={{fontSize: '14px', color: '#666', marginTop: '10px', fontStyle: 'italic'}}>
Saved Dashboards page with favorites, tags, search, and actions
</p>
</div>


### How to Save a Dashboard

1. Click **New Dashboard** in the top-right corner.
Expand All @@ -28,3 +33,5 @@ A saved dashboard includes:
5. Save the dashboard.

Once the process is complete, you will be able to see your saved dashboard.
**Save View**: Click "Save Current View" and provide a name

Loading