Add Changelog and contribution page

henryk86 commented 7 months ago

There is the idea to add a Changelog/Release description and contributor page in the server.

lets discuss here how to structure it.

Some open questions:

introduce a new navigation item community? With subitems Changelog, contributors, contributions (how to support the project), forum (link to forum, not integrated) (like it‘s done here: https://www.tensorflow.org/community - do you know better examples?)
or use an existing item? Which one? Settings? Home?

SciLor commented 7 months ago

I would put it into the menu as last item. Community or About is a nice idea.

henryk86 commented 7 months ago

A first draft is included in the PR https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/29

henryk86 commented 6 months ago

@SciLor : the changelog data can be handled as a json and so it could be part of the last commit. Then provide the json through an api like the tonieboxes.

Example json:

[
     {
      version: "0.5.x",
      changes: [
        "fixed several bugs"
      ],
      commits: [],
      discussionLink: "https://forum.revvox.de/t/release-notes-0-5-x",
      githubReleaseLink: "https://github.com/toniebox-reverse-engineering/teddycloud/releases/tag/tc_v0.5.x"
    },
    {
      version: "0.5.0",
      changes: [
        "security mitigations on public instances as it‘s definitely not recommended to host teddycloud in public accessible for all",
        "prepared authentication for frontend (backend adaptions)",
        "linked new /web gui on teddycloud administration gui",
        "overworked header, reordered menu items, new icons, better readable status in new /web gui",
        "fixed modals (still some display problems on small devices like mobiles exists)",
        "added audio encoder to new /web gui, you are now able to select files and encode them to a taf",
        "This lets you bring your own content easily on an existing tonie.", // This line added
        "added toniebox management to new /web gui, improved backend functions for that",
        "only at least once connected boxes are listed, model must be set manually",
        "enriched homepage in new /web gui with 5 randomly selected tonies of yours",
        "adapt tonie card list to different cover image sizes in new /web gui (all cards within one row have now the same height)",
        "added no cloud and live icon (Toggle to enable/disable) on tonie card in new /web gui",
        "fixed several bugs"
      ],
      commits: [
        "https://github.com/toniebox-reverse-engineering/teddycloud/pull/154",
        "https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/8",
        "https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/9",
        "https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/19",
        "https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/21",
        "https://github.com/toniebox-reverse-engineering/teddycloud_web/pull/22"
      ],
      discussionLink: "https://forum.revvox.de/t/release-notes-0-5-0/444",
      githubReleaseLink: "https://github.com/toniebox-reverse-engineering/teddycloud/releases/tag/tc_v0.5.0"
    },
    {
      version: "0.4.5 and older",
      changes: [
        "A lot more. See Github for details!"
      ],
      commits: []
    }
  ]

henryk86 commented 6 months ago

Move changelog into json is postponed. For now it’s part of the changelog element itself.

toniebox-reverse-engineering / teddycloud_web

Add Changelog and contribution page #27