-
Notifications
You must be signed in to change notification settings - Fork 35
Feature/docs ia revamp : Information Architecture Revamp and Streamlining. #102
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
Open
Mike-4-prog
wants to merge
9
commits into
OpsiMate:main
Choose a base branch
from
Mike-4-prog:feature/docs-ia-revamp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d36fae7
docs: revamp documentation information architecture
Mike-4-prog 2905ffc
docs: IA revamp with glossary, FAQ, alerts updates, and MDX migration
Mike-4-prog f6b3905
Fix localhost URLs and code formatting issues
Mike-4-prog abd9826
Fix all PR issues
Mike-4-prog b5372e9
Fix remaining CodeRabbit issues
Mike-4-prog 6d84ad2
Fix dark theme CSS variables (final fix)
Mike-4-prog 7252603
Remove duplicate CSS variable declarations
Mike-4-prog 9148851
Remove duplicate .md files causing build errors
Mike-4-prog de90332
Fix sidebars.js with correct IA revamp structure
Mike-4-prog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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**. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> | ||
| ``` | ||
| ## 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. | ||
|
|
||
|
|
||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 48
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 48
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 48
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 48
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 89
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 206
🏁 Script executed:
Repository: OpsiMate/documentation
Length of output: 378
🏁 Script executed:
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 inopsimate-docs/src/components/. The only available components areCookieConsentandGoogleAnalytics. 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