loopbackio / loopbackio/loopback-next
Documentation Change Logs are Frequently Outdated
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.1k
- Forks
- 1.1k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 27
Description
## 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:
- https://loopbackio.slack.com/archives/C01177XQN8N/p1626802414083800
- https://loopbackio.slack.com/archives/C01177XQN8N/p1639416915225600
## 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](https://github.com/loopbackio/loopback.io/issues/1269), 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the changelog page at https://loopback.io/doc/en/lb4/changelog.repository.html and compare its entries with the versions published for LoopBack packages on npmjs.org. Trace how package releases and documentation publication currently connect, then define an automated process whose completed result is an up-to-date changelog after each package release.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100