Skip to content

Fix/move rule management to chatops#29

Merged
thinker8581 merged 3 commits intovolcengine:mainfrom
songyu-bytedance:fix/move-rule-management-to-chatops
Nov 13, 2025
Merged

Fix/move rule management to chatops#29
thinker8581 merged 3 commits intovolcengine:mainfrom
songyu-bytedance:fix/move-rule-management-to-chatops

Conversation

@songyu-bytedance
Copy link
Collaborator

Summary

Reorganized documentation structure by moving the rule management documentation from the "Configurations" section to the "ChatOps" section, where it more appropriately belongs as a core ChatOps feature.

Changes

Documentation Structure

  • Moved: docs/content/2.configurations/8.rule-management.mddocs/content/3.chatops/6.rule-management.md
  • Updated: Navigation configurations for both sections
  • Cleaned: Removed backup file docs/nuxt.config.js.bak

Navigation Updates

  • Removed rule management entry from 2.configurations/.navigation.yml
  • Added complete navigation links in 3.chatops/.navigation.yml:
    • Overview
    • Interest Agent
    • Proactive Agent
    • Reactive Agent
    • Configuration
    • Rule Management (newly added)

No Breaking Changes

  • ✅ Frontend route path remains unchanged (/oncall/config)
  • ✅ Frontend code structure unchanged (oncall/features/config)
  • ✅ All existing functionality preserved

Rationale

Rule management is fundamentally a ChatOps feature - it configures interest detection rules for chat message analysis. Placing it under the ChatOps section:

  • Improves documentation discoverability
  • Better reflects the feature's core purpose
  • Aligns with the logical organization of ChatOps-related documentation

Testing

  • Documentation site builds successfully
  • Navigation links work correctly
  • Rule management doc displays properly in ChatOps section
  • Fixed better-sqlite3 module compatibility issue

Commits

  1. b1d6b1a - Move rule management doc from configurations to chatops section
  2. e8396b1 - Update navigation configs for rule management relocation
  3. 72e054f - Fix rule management access URL to keep original path

…s section

Moved rule-management.md from 2.configurations/ to 3.chatops/ directory
to better organize ChatOps-related documentation.

Changes:
- Moved: docs/content/2.configurations/8.rule-management.md -> docs/content/3.chatops/6.rule-management.md
- Kept original route path (/oncall/config) unchanged
- Removed backup file: docs/nuxt.config.js.bak

Rationale:
- Rule management is a core ChatOps feature
- Should be documented under ChatOps section for better discoverability
Updated documentation navigation structure:
- Removed rule management from configurations section
- Added rule management to ChatOps section with complete navigation links

Changes:
- docs/content/2.configurations/.navigation.yml: Removed rule management entry
- docs/content/3.chatops/.navigation.yml: Added all ChatOps links including rule management

This aligns with the previous doc reorganization where rule-management.md
was moved from configurations to chatops section.
Fixed the access URL in rule-management.md to keep the original path.

Changes:
- Reverted URL from /chatops/rule-management to /oncall/config
- Only documentation location changed, route path remains unchanged

This ensures documentation reflects the actual route path.
@thinker8581 thinker8581 merged commit 0d924fc into volcengine:main Nov 13, 2025
piggesthjy pushed a commit to piggesthjy/veaiops that referenced this pull request Nov 14, 2025
## Summary

Reorganized documentation structure by moving the rule management
documentation from the "Configurations" section to the "ChatOps"
section, where it more appropriately belongs as a core ChatOps feature.

## Changes

### Documentation Structure
- **Moved**: `docs/content/2.configurations/8.rule-management.md` →
`docs/content/3.chatops/6.rule-management.md`
- **Updated**: Navigation configurations for both sections
- **Cleaned**: Removed backup file `docs/nuxt.config.js.bak`

### Navigation Updates
- **Removed** rule management entry from
`2.configurations/.navigation.yml`
- **Added** complete navigation links in `3.chatops/.navigation.yml`:
  - Overview
  - Interest Agent
  - Proactive Agent
  - Reactive Agent
  - Configuration
  - Rule Management (newly added)

### No Breaking Changes
- ✅ Frontend route path remains unchanged (`/oncall/config`)
- ✅ Frontend code structure unchanged (`oncall/features/config`)
- ✅ All existing functionality preserved

## Rationale

Rule management is fundamentally a **ChatOps feature** - it configures
interest detection rules for chat message analysis. Placing it under the
ChatOps section:
- Improves documentation discoverability
- Better reflects the feature's core purpose
- Aligns with the logical organization of ChatOps-related documentation

## Testing

- [x] Documentation site builds successfully
- [x] Navigation links work correctly
- [x] Rule management doc displays properly in ChatOps section
- [x] Fixed `better-sqlite3` module compatibility issue

## Commits

1. **b1d6b1a** - Move rule management doc from configurations to chatops
section
2. **e8396b1** - Update navigation configs for rule management
relocation
3. **72e054f** - Fix rule management access URL to keep original path
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants