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

Show changelog on core update #1884

Open
pablomendezroyo opened this issue Mar 11, 2024 · 0 comments
Open

Show changelog on core update #1884

pablomendezroyo opened this issue Mar 11, 2024 · 0 comments
Assignees
Labels
frontend/UIX Task to improve, edit or fix anything related to User Interface Experience and/or the frontend P1 Has to be done but not urgent

Comments

@pablomendezroyo
Copy link
Contributor

pablomendezroyo commented Mar 11, 2024

After a core release, there might be several changes to core packages (dappmanager, ipfs, wireguard, etc) without the user notifying any of them. To provide the user a better feedback about what is going on, design a changelog to be displayed right after the core release:

Implementation

  • Find a project directory path for the changelog, that should have the following file structure:
    • changelog
      • vx.y.z
        • 1
          • changes.md
          • img.png
  • Implement the corresponding COPY (s) in the Dockerfile
  • Implement the Modal component
  • Whenever a core update gets triggered, it should reflect this status on disk (probably on db), defining the current core version.
  • Trigger the show Modal event whenever the dappmanager starts and finds it has been updated using dappnode state systemInfo
  • Consider only showing the Modal if it exists in the previous version and/or it's a patch update

Changelog modal

  • There should be a title indicating the version to where it has been updated and ideally from which version was updated
  • The modal will be in markdown text
  • The modal will be a stepper of new features on each step and an optional image
  • Consider adding img/s to be rendered in the modal
@pablomendezroyo pablomendezroyo added P1 Has to be done but not urgent frontend/UIX Task to improve, edit or fix anything related to User Interface Experience and/or the frontend labels Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend/UIX Task to improve, edit or fix anything related to User Interface Experience and/or the frontend P1 Has to be done but not urgent
Projects
None yet
Development

No branches or pull requests

3 participants