Migrate the Monkey365 documentation site from Material for MkDocs to Zensical

Aberta
  • Algo errado?
#184 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
30/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Pouca atividade
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
PowerShell
Estrelas
1.4k
Forks
144
Merge médio
1d 21h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de silverhack/monkey365

Todas as issues de silverhack/monkey365

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.