disabling-services
Safely hide services from the Coolify documentation listing while preserving existing pages for SEO, bookmarks, and historical reference.
Introduction
This skill provides a systematic approach for deprecating or hiding service documentation within the Coolify ecosystem. It is designed for documentation maintainers who need to remove a service from the primary navigation and index pages—such as those listed in the service catalog—without breaking external links or losing search engine optimization (SEO) equity. By keeping the documentation file active but marked as disabled, you ensure that existing users who rely on direct bookmarks or search results can still access critical historical information, migration paths, or transition instructions.
-
Automatically filter services from the central service catalog and listing pages using internal script processing.
-
Support for explicit status declaration via YAML frontmatter
disabled: true. -
Pattern-based detection for warning callouts, allowing developers to hide services automatically when specific phrases like 'SERVICE NOT AVAILABLE' are detected in the markdown body.
-
Integration with VitePress and custom generation scripts (scripts/services-data.mjs) to maintain consistent site-wide state.
-
Preservation of redirect configurations, ensuring that traffic remains routed correctly even after a service is removed from the public listing.
-
The process requires execution of
bun run generate:servicesto update the underlyingservices.jsonandall.mdfiles; failing to regenerate these files will result in inconsistent documentation states. -
Use the frontmatter
disabled: trueas the canonical signal to ensure the build script correctly processes the change, regardless of prose content. -
When documenting a disabled service, always include a warning callout at the top of the file to inform users of the service's current state, such as 'DEPRECATED', 'REMOVED', or 'TEMPORARILY DISABLED'.
-
Provide clear migration paths or alternative services within the document body to assist users who are affected by the service removal.
-
Ensure that all regenerated files—specifically
services.jsonandall.md—are included in your Git commits to reflect the changes in the production environment. -
This workflow is strictly intended for documentation maintenance and does not affect the actual deployment or functionality of services within the Coolify software platform; it is a content-management-only procedure.
Repository Stats
- Stars
- 343
- Forks
- 281
- Open Issues
- 44
- Language
- JavaScript
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- May 1, 2026, 09:55 AM