Add changelog page

Add changelog page

Summary

  • Situation: Neither we nor the users have a visible track of what changed and when.
  • Problem: As a user, I want to be able to easily see what changes have been made to the application.
  • Solution: Introduce a changelog page where users can view a detailed list of changes, updates, and bug fixes for each version of the application. use https://tailwindui.com/templates/commit as a template. and add the changelogs manually for now.
  • Appetite: 1 day

Situation

Currently, users and our team lack a clear understanding of the changes made to the application with each update. While we may document these changes internally, they are not easily accessible to users.

Problem

Users find it difficult to track what changes have been implemented in each version of the application. They want to be able to understand the improvements, bug fixes, and new features without having to dig through any release notes. Currently, there is no dedicated place for users to view this information directly within the application.

Appetite

Solution

  1. Create Changelog Page: Design and implement a new page within the application specifically for displaying changelog information.
    1. Probably datahub.io/changelog.
    2. Have a link on the landing page that refers to this page from the settings menu or homepage.
  2. Version Tracking: Automatically populate the changelog with details of each update, including version number, release date, and a summary of changes.
    1. Probably we can use npm package changeset.
  3. User Interface: Design the changelog page to be user-friendly, with clear navigation and concise descriptions of changes for each version.
    1. We should add
      • application version
      • release date
      • list of changes
      • maybe a URL referring to docs on how to use the new changes
    2. Use emojis
      • 🐛: Bug fixes
      • ✨: New features
      • 🔄: Enhancements or improvements
      • 🚀: Performance improvements
  4. Update Process: Establish a procedure for updating the changelog with each new release, ensuring that it remains accurate and up-to-date.

Rabbit-holes

  • User Feedback: Explore options for allowing users to provide feedback or comments on specific changes within the changelog.

No-goes

  • Automated Updates: We should rely on manual updates for the changelog.
  • Overly Technical Language: We should avoid using overly technical language or jargon in the changelog descriptions.

© 2024 All rights reservedBuilt with DataHub Cloud

Built with LogoDataHub Cloud