# SP Docs - Full Context > Generated by docmd --- ## [Docs Workspace ServicePilot](https://docs.myproject.com/) --- title: "Docs Workspace ServicePilot" description: "Espace de travail pour les documentations ServicePilot." --- # Docs Workspace ServicePilot 🚀 Ce site est le portail interne qui présente et organise les sites de documentation ServicePilot. Il offre un accès rapide aux docs, procédures, ressources techniques essentielles ainsi que l'avancement des projets. - [Docmd Official Documentation](external:https://docs.docmd.io) - [Composants Docmd](external:https://docs.docmd.io/content/containers/) - [Icones Lucide](external:https://lucide.dev/icons/) ## Liens des docs | Category | Name | EN | FR | ES | | -- | -- | -- | -- | -- | | **Introduction** | What is ServicePilot | [en](external:/en/doc/what-is-servicepilot/) | [fr](external:/fr/doc/what-is-servicepilot/) | [es](external:/es/doc/what-is-servicepilot/) | | **Getting Started** | Getting started | [en](external:/en/doc/getting-started/) | [fr](external:/fr/doc/getting-started/) | [es](external:/es/doc/getting-started/) | | | Concepts | [en](external:/en/doc/concepts/) | [fr](external:/fr/doc/concepts/) | [es](external:/es/doc/concepts/) | | | Monitoring hierarchy | [en](external:/en/doc/hierarchy/) | [fr](external:/fr/doc/hierarchy/) | [es](external:/es/doc/hierarchy/) | | | Data collection | [en](external:/en/doc/data-collection/) | [fr](external:/fr/doc/data-collection/) | [es](external:/es/doc/data-collection/) | | | Agents | [en](external:/en/doc/agents/) | [fr](external:/fr/doc/agents/) | [es](external:/es/doc/agents/) | | **Operation** | View data collected | [en](external:/en/doc/view-data-collected/) | [fr](external:/fr/doc/view-data-collected/) | [es](external:/es/doc/view-data-collected/) | | | Search | [en](external:/en/doc/search/) | [fr](external:/fr/doc/search/) | [es](external:/es/doc/search/) | | | Dashboards | [en](external:/en/doc/dashboards/) | [fr](external:/fr/doc/dashboards/) | [es](external:/es/doc/dashboards/) | | | Reporting | [en](external:/en/doc/reporting/) | [fr](external:/fr/doc/reporting/) | [es](external:/es/doc/reporting/) | | | Operation | [en](external:/en/doc/operation/) | [fr](external:/fr/doc/operation/) | [es](external:/es/doc/operation/) | | | AI | [en](external:/en/doc/ai/) | [fr](external:/fr/doc/ai/) | [es](external:/es/doc/ai/) | | **Administration** | Users | [en](external:/en/doc/users/) | [fr](external:/fr/doc/users/) | [es](external:/es/doc/users/) | | | Policies | [en](external:/en/doc/policies/) | [fr](external:/fr/doc/policies/) | [es](external:/es/doc/policies/) | | | Alerting | [en](external:/en/doc/alerting/) | [fr](external:/fr/doc/alerting/) | [es](external:/es/doc/alerting/) | | | On-premise | [en](external:/en/doc/onpremise/) | [fr](external:/fr/doc/onpremise/) | [es](external:/es/doc/onpremise/) | | | Cluster | [en](external:/en/doc/cluster/) | [fr](external:/fr/doc/cluster/) | [es](external:/es/doc/cluster/) | | | APM | [en](external:/en/doc/apm/) | [fr](external:/fr/doc/apm/) | [es](external:/es/doc/apm/) | | | Mainframe | [en](external:/en/doc/mainframe/) | [fr](external:/fr/doc/mainframe/) | [es](external:/es/doc/mainframe/) | | | Licenses | [en](external:/en/doc/licenses/) | [fr](external:/fr/doc/licenses/) | [es](external:/es/doc/licenses/) | | **Integration** | API | [en](external:/en/doc/api/) | [fr](external:/fr/doc/api/) | [es](external:/es/doc/api/) | | | Third parties | [en](external:/en/doc/thirdparties/) | [fr](external:/en/doc/thirdparties/) | [es](external:/es/doc/thirdparties/) | ## Nouvel environnement - Liens en haut à droite de l’intranet - Compilation du markdown à la volée - Sources markdown : \\\10.1.1.100\webdocs - Images : comme avant - Migrations effectuées - collapse -> collapsible - blockquote -> callout info - tableau step -> steps - zoom d’image - Chemins d'images/de vidéo absolus - Corrections html « ::: » et « | » - Corrections des « steps » (1., 2., 3., …) - Traduction des titres - Création de 3 nouvelles pages depuis getting-started + mises dans le menu « Operation » - View data collected > monitoring - View data collected > dashboards - View data collected > tools - "La page « reporting » est bizarre et reprend un peu comme « dashboards »" --> Division en 2 pages distinctes - Les concepts possèdent une page / entrée dédiée dans la section getting started (anciennement dans getting started) - Les vues et le concept de hiérarchie de supervision possèdent une page / entrée dédiée dans la section getting started (anciennement dans data collection) - Nouvelle page AI - Nouvelles pages incluses dans build cmd, _seo, _inc_pages, json, md ## Reste à faire : forme - Comparer les différentes langues - Vérifier les images/video : il doit y avoir un texte à gauche ou une petite liste « steps » - Améliorer les composants (Tabs si opportun à voir, collapsible pour def K8S Agent [fait - OK]) ## Reste à faire : fond - Créer des compléments markdown ou images ## Bonnes pratiques - Fichiers de doc - **Position des lignes** : Garder une cohérence entre le contenu et le numéro des lignes pour qu'un titre soit sur la même ligne peu importe la langue. - Screenshot - **Standard de résolution** : utiliser une résolution fixe (ex. 1600×900) pour éviter les variations d’affichage sauf pour les mini screenshots (ex. bouton, etc.). - **Format d’image** : PNG pour l’interface, JPG uniquement pour les images lourdes. - **Nommage normalisé** : servicepilot_feature_action_01.png ou sp_alerts_create_01.png - **Anonymisation** : masquer IP, noms d’utilisateurs, données clients. - **Mise en avant des zones importantes** : utiliser des rectangles, flèches, numéros, mais jamais trop d’annotations. - **Thème visuel cohérent** : toujours utiliser le même thème ServicePilot (privilégier clair). - Schémas - **Outils** : Draw.io ou Powerpoint - **Icône uniformes** : icônes intégrés au produit ou Bootstrap / Lucid selon les besoins - **Couleurs uniformes** : ex. bleu composants ServicePilot, vert sources externes, etc. - **Export standardisé** : PNG pour la doc, SVG ou PPT pour garder la source - **Nommage normalisé** : ex. achitecture-collector-overview.svg - SVN - **Fonctionnement** : les .md sont mis dans le SVN chaque semaine à des fins de sauvegarde - **Images** : les images sont à commiter dans le SVN pour être prises en compte ## Quick Start You are currently viewing `docs/index.md`. ```bash npx @docmd/core dev # Start the dev server npx @docmd/core build # Build for production ``` ## Features Demo ### 1. Smart Containers ::: callout tip "Did you know?" You can nest containers, add custom titles, and use emojis! :tada: ::: ::: card "Flexible Structure" Organise your content with cards. ::: button "View Documentation" https://docs.docmd.io ::: ### 2. Tabs & Code ::: tabs == tab "JavaScript" ```javascript console.log('Hello World'); ``` == tab "Python" ```python print('Hello World') ``` ::: ### 3. Plugins (Enabled by Default) - **Search** - **Sitemap** - **SEO Optimisation** - **Git Integration** - **Mermaid Diagrams** - **LLMs Context** ## Next Steps - **[Official Documentation](https://docs.docmd.io)** - **[Customise Theme](https://docs.docmd.io/theming/available-themes)** - **[Deploy Site](https://docs.docmd.io/deployment)** Happy documenting! 🎉 ---