loopbackio / loopbackio/loopback-next

Documentation Change Logs are Frequently Outdated

Abierto
#8,120 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug Docs
Lenguaje dominante
TypeScript
Estrellas
5.1k
Forks
1.1k
Merge medio
2 d 21 h
PR fusionados (30 d)
27

Descripción

URL of the page

https://loopback.io/doc/en/lb4/changelog.repository.html
(and possibly others)

Nature of the issue

The change logs for Loopback packages on the official documentation site sometimes go without any updates for a long time after new versions are published on npmjs.org.

Expected behavior

Change logs on the Loopback documentation website should always include information about the most recent versions of Loopback packages published on npmjs.org.

Actual behavior

Today (2021-12-13), I have noted that @loopback/repository 4.0.0 was published 2021-11-18, yet the change log at the time of this writing only reports up to version 3.7.3 and is dated for 2021-10-18.

I have brought up this issue on Slack at #loopback-users and it is the second time I have done so. The first time was 2021-07-20.

Here are slack links to both of these previous reports:

Suggested resolution

Updates to change log should be automatically published for new versions at the same time as (or possibly slightly before) the code version, possibly through the use of a web hook or other trigger. This process should occur automatically without human intervention so that it does not accidentally get skipped. Someone should verify that the documentation publication is up to date after the publish of the npmjs.org package updates.

Other Notes

I previously opened this issue report here, but that issue tracker doesn't seem to get very much attention, and I have noticed that many issues for loopbackio/loopback-next are explicitly tagged as "Docs." Therefore I am re-reporting the issue here.

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

Comienza con la página del changelog en https://loopback.io/doc/en/lb4/changelog.repository.html y compara sus entradas con las versiones publicadas para los paquetes de LoopBack en npmjs.org. Analiza cómo se conectan actualmente las releases de los paquetes y la publicación de la documentación, y luego define un proceso automatizado cuyo resultado final sea un changelog actualizado después de cada release de un paquete.

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

Evaluación

Área
documentation, release
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.