Migrate the Monkey365 documentation site from Material for MkDocs to Zensical
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- Calme
- Domaine
- documentation
Piste de recherche
Start with the current Monkey365 documentation site and the linked Zensical reference, then inspect the repository's existing documentation configuration and navigation. Done means the site runs on Zensical, its structure is redesigned, and the proposed architecture, collector, rule, ruleset, and contributor topics are documented with build and link validation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Summary
Migrate the Monkey365 documentation site from Material for MkDocs to Zensical and use the migration as an opportunity to redesign and significantly expand the project documentation.
Material for MkDocs is now in maintenance mode, with development focused on Zensical. Although critical fixes and security updates will continue for a limited period, no new features are expected to be added to Material for MkDocs.
Motivation
The current documentation provides a good introduction to installing, configuring, and running Monkey365. However, many of the project's most powerful capabilities and internal concepts are not documented yet.
Migrating the documentation platform would be a good opportunity to:
- Redesign the documentation structure and navigation.
- Improve the contributor and authoring experience.
- Document Monkey365's architecture and internal workflows.
- Make advanced customisation and extension points easier to understand.
- Help users and contributors realise the full potential of Monkey365.
Proposed documentation areas
The redesigned documentation could include dedicated sections for the following topics.
Architecture and core internals
- High-level architecture.
- Execution lifecycle.
- Module and component responsibilities.
- Authentication and connection management.
- Internal data flow.
- Error handling, logging, retries, and throttling.
- Report generation pipeline.
Collectors
- Collector lifecycle.
- Collector structure and conventions.
- Supported data sources.
- How collectors are discovered and executed.
- Creating a custom collector.
- Collector configuration.
- Collector output contracts.
Collector helpers
- Available helper functions.
- Authentication and API request helpers.
- Pagination and retry helpers.
- Logging helpers.
- Error-handling conventions.
- Performance considerations.
- Examples of using helpers in custom collectors.
Data normalisation and aggregation
- Normalised object structure.
- Provider-specific transformations.
- Type and property conventions.
- How normalised and aggregated data is consumed by rules and reports.
Declarative rules
- Rule schema and supported properties.
- Rule metadata.
- Query and condition syntax.
- Evidence generation.
- Severity and classification.
- Creating and validating a custom rule.
- Complete rule examples.
Rule evaluation
- Rule discovery and loading.
- Evaluation lifecycle.
- How collected data is selected.
- Query execution.
- Pass and fail error states.
- Evidence construction.
- Debugging rule evaluation.
Rulesets
- Ruleset structure.
- Rule selection and grouping.
- Creating organisation-specific rulesets.
- Versioning and maintaining rulesets.
- Sharing reusable rulesets.
Contributor documentation
- Documentation development environment.
- Documentation style guide.
- Contribution workflow.
- Adding new pages and navigation entries.
- Link, formatting, and build validation.
References
- Monkey365 documentation: https://silverhack.github.io/monkey365/
- Zensical: https://zensical.org/
- Material for MkDocs maintenance-mode announcement: https://github.com/squidfunk/mkdocs-material/issues/8523
- Langage dominant
- PowerShell
- Étoiles
- 1.4k
- Forks
- 144
- Merge moyen
- 1 j 21 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de silverhack/monkey365
-
bug status/needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
silverhack/monkey365#200 ·
-
bug status/needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
silverhack/monkey365#199 ·
-
bug status/needs-triage
Difficulté 4/5 3-5 jours Accessibilité débutants 56/100
silverhack/monkey365#198 ·
-
documentation enhancement help wanted impact-low priority-medium question
Difficulté 4/5 3-5 jours Accessibilité débutants 68/100
silverhack/monkey365#187 · 1 commentaire ·
-
Expose domain-level context for SPF / DKIM / DMARC findings in Exchange OnlinePeut-être à nouveau libre @silverhack l’a pris il y a 112 jours, et aucune pull request n’est ouverte. Ouverteenhancement
silverhack/monkey365#167 · 3 commentaires · 1 personne assignée ·
Toutes les issues de silverhack/monkey365
Issues similaires
-
Blog update untriaged
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
-
sync-en
Difficulté 1/5 1-3 heures Accessibilité débutants 84/100
Les mainteneurs répondent en général sous 1 jour
-
sync-en
Difficulté 1/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 83/100
GSA/digital-gov-drupal#569 ·
Les mainteneurs répondent en général sous 2 jours