Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creating a new "Renovate and changelogs" page in the docs #25874

Closed
rarkins opened this issue Nov 20, 2023 Discussed in #25867 · 2 comments · Fixed by #25982
Closed

Creating a new "Renovate and changelogs" page in the docs #25874

rarkins opened this issue Nov 20, 2023 Discussed in #25867 · 2 comments · Fixed by #25982
Assignees
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people status:in-progress Someone is working on implementation type:docs Documentation

Comments

@rarkins
Copy link
Collaborator

rarkins commented Nov 20, 2023

Discussed in #25867

Originally posted by HonkingGoose November 19, 2023

Tell us more.

Background

Many users ask about how Renovate fetches changelogs. The maintainers of course answer most of those questions, but we should get those answers and concepts into the docs.

Current info

The Renovate docs mention changelogs in a few places:

Related issue:

Discussion

It would be nice to have a single page that explains common questions and concepts, like:

  • How Renovate "sees" changelogs
  • From which platforms can Renovate fetch changelogs
  • Troubleshooting missing changelogs
  • Advice for package maintainers (do x to get Renovate to see changelogs)
    • npm package advice
    • yarn package advice
    • other "big/much used" package advice
  • Apparently Renovate can read a changelog.json file, again JSON, I don't think we explain that at all...
  • Other things I'm forgetting to list, feel free to suggest!
@rarkins rarkins added priority-4-low Low priority, unlikely to be done unless it becomes important to more people type:docs Documentation labels Nov 20, 2023
@HonkingGoose
Copy link
Collaborator

@rarkins want me to start a draft PR that you can help fill out with suggestions?

@HonkingGoose HonkingGoose self-assigned this Nov 27, 2023
@HonkingGoose HonkingGoose added the status:in-progress Someone is working on implementation label Nov 27, 2023
@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 37.103.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people status:in-progress Someone is working on implementation type:docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants