Migrate the Monkey365 documentation site from Material for MkDocs to Zensical

Aperta
  • Qualcosa non va?
#184 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation enhancement epic priority-medium

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

Lingua principale
PowerShell
Stelle
1.4k
Fork
144
Merge medio
1g 21h
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di silverhack/monkey365

Tutte le issue di silverhack/monkey365

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.