theupdateframework / theupdateframework/python-tuf

doc: consider re-adding a "quickstart" document

Abierto
#1,797 7 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Supersedes https://github.com/theupdateframework/python-tuf/issues/1006

Description of issue or feature request:
#1790 removes QUICKSTART.md because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar with python-tuf and are also easy to discover (e.g. via main README and main menu on RTD).

Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).

Current behavior:

  • no explicit "quick start" documentation

Expected behavior:

  • consider adding quick start documentation or better frame existing documentation

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.

Línea de trabajo

Revisa los ejemplos de cliente y repositorio en examples/ y, a continuación, rastrea cómo están enlazados desde README.md y docs/index.rst después de que QUICKSTART.md se eliminara mediante #1790. Compara el material existente con el objetivo de quick-start solicitado y el criterio de la insignia CII; el trabajo estará terminado cuando el enfoque de la documentación y el contexto o las adiciones necesarios estén claramente definidos e implementados.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.