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

Proposal: Add Changelog in generated docs #24

Open
vipulgupta2048 opened this issue Dec 6, 2022 · 0 comments
Open

Proposal: Add Changelog in generated docs #24

vipulgupta2048 opened this issue Dec 6, 2022 · 0 comments

Comments

@vipulgupta2048
Copy link
Member

Originally the idea was to have Changelogs be part of docs: https://6072976c.balena-fin.pages.dev/changelog
This was removed in #23

Why?

  • Changelogs didn't have closing tags for several elements leading to docusaurus unhappy
  • Changelogs had markdown links breaking leading to errors on build

With the immutable nature of Changelogs, it's very hard to change existing Changelogs to follow the latest template that have since rectified some of these issues. We can talk more about how to bring these back in a way where it's less breaking changes on build time.

Zulip: https://balena.zulipchat.com/#narrow/stream/345882-_help/topic/Where.20are.20changelogs.20created.3F

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant