Restructure docs directory

Abierto
#1,849 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Comienza revisando el directorio docs existente y el issue relacionado #1848 para identificar los tipos de documentación que actualmente están mezclados. Define una estructura que distinga entre ADRs, contenido de Read the Docs y documentos misceláneos; se considera completado cuando las categorías están claramente separadas y la documentación existente sigue estando contemplada.

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

Descripción

documentation low-prio

Description of issue or feature request:

Current behavior:
No clear distinction of different documentation types in docs directory.

Expected behavior:
Clear distinction of different documentation types in docs directory, e.g. along the following categories:

  • adr
  • rtd (e.g. see sphinx-quickstart dir scaffolding)
  • misc docs that are neither an adr, nor rendered on rtd (?)

related: see #1848

Lenguaje dominante
Python
Estrellas
1.7k
Forks
304
Merge medio
1 d 2 h
PR fusionados (30 d)
17

Guía de contribución

Abrir la guía de contribución

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 theupdateframework/python-tuf

Todos los issues de theupdateframework/python-tuf

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.