Docs: Autogenerate threats into docs

Abierto
#304 10 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python

Línea de trabajo

Empieza leyendo pytm/threatlib/threats.json y docs/threats.md, y después revisa la discusión de MkDocs enlazada y el issue relacionado #279. El trabajo estará terminado cuando la documentación se genere a partir de los datos de amenazas compatibles y ya no requiera duplicar manualmente las entradas de amenazas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

If we#d use mkdocs for generating docs we could use the approach represented in https://github.com/mkdocs/mkdocs/discussions/3487#discussioncomment-7681213 potentially to free our self from manually updating supported threats defined in https://github.com/OWASP/pytm/blob/master/pytm/threatlib/threats.json into https://github.com/OWASP/pytm/blob/master/docs/threats.md .

Would this be helpful @Dakes @nineinchnick ?

This idea would align with other ideas like #279 .

Lenguaje dominante
Python
Estrellas
1.2k
Forks
237
Merge medio
4 d 2 h
PR fusionados (30 d)
9

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OWASP/pytm

Todos los issues de OWASP/pytm

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.