Skip to content

Write release notes for v5.0.0 #951

Open
Open
Write release notes for v5.0.0#951
Assignees
kjetilkrubensworks
Labels
documentation
Milestone
5.0.0

Description

@RubenVerborgh
RubenVerborgh
opened on Nov 19, 2018

Include upgrade notes (see #946)

Activity

  1. RubenVerborgh
    added
    documentation
    on Nov 19, 2018
  2. RubenVerborgh
    added this to the 5.0.0 milestone on Nov 19, 2018
  3. kjetilk
    assigned
    kjetilk
    and
    rubensworks
    on Nov 19, 2018

  4. rubensworks commented on Nov 20, 2018

    @rubensworks
    rubensworks
    on Nov 20, 2018
    Contributor

    I assume this is for the CHANGELOG.md?
    How is this file currently updated? Manually, or with some tool?

  5. kjetilk commented on Nov 20, 2018

    @kjetilk
    kjetilk
    on Nov 20, 2018
    Member

    Yeah, I think we can put it in there. Right now, it isn't updated. I spent an hour trying to hack a tool so that we could use the DOAP changeset vocab to maintain the changelog, like I do with my Perl modules, but it wasn't that straightforward to extract out of the toolset.

  6. rubensworks commented on Nov 20, 2018

    @rubensworks
    rubensworks
    on Nov 20, 2018
    Contributor

    the DOAP changeset vocab to maintain the changelog, like I do with my Perl modules

    Oh, nice :-)

    but it wasn't that straightforward to extract out of the toolset

    I recently created manual-git-changelog for automating changelogs as much as possible in my projects. Not sure exactly what the release workflow for NSS is exactly, but if it matches with my workflow, then this might be a useful tool to use here.

  7. melvincarvalho commented on Nov 21, 2018

    @melvincarvalho
    melvincarvalho
    on Nov 21, 2018 · Hidden as off-topic

  8. RubenVerborgh commented on Nov 21, 2018

    @RubenVerborgh
    RubenVerborgh
    on Nov 21, 2018 · Hidden as off-topic
    Author

  9. melvincarvalho commented on Nov 21, 2018

    @melvincarvalho
    melvincarvalho
    on Nov 21, 2018 · Hidden as off-topic

  10. rubensworks commented on Nov 21, 2018

    @rubensworks
    rubensworks
    on Nov 21, 2018 · Hidden as off-topic

  11. melvincarvalho commented on Nov 21, 2018

    @melvincarvalho
    melvincarvalho
    on Nov 21, 2018 · Hidden as off-topic

  12. RubenVerborgh commented on Nov 21, 2018

    @RubenVerborgh
    RubenVerborgh
    on Nov 21, 2018 · Hidden as off-topic
    Author

  13. melvincarvalho commented on Nov 21, 2018

    @melvincarvalho
    melvincarvalho
    on Nov 21, 2018 · Hidden as off-topic

  14. melvincarvalho commented on Nov 23, 2018

    @melvincarvalho
    melvincarvalho
    on Nov 23, 2018 · Hidden as off-topic

  15. 17 remaining items

  16. kjetilk commented on Dec 13, 2018

    @kjetilk
    kjetilk
    on Dec 13, 2018
    Member

    Come to think of: We need a note on updating files in the POD in the upgrade instructions, right?

  17. megoth commented on Dec 13, 2018

    @megoth
    megoth
    on Dec 13, 2018
    Contributor

    I think we also need to mention the commands invalidusernames and updateindex somewhere; maybe not the release notes, but I don't think we've documented this beside the help texts in the CLI.

    We should also note that before doing updateindex the first time, the POD owners should be notified that they need to change their index.html if they want to keep the old one (a tutorial for this is available at https://github.com/megoth/solid-update-index-tutorial).

  18. RubenVerborgh commented on Dec 13, 2018

    @RubenVerborgh
    RubenVerborgh
    on Dec 13, 2018 via email
    ContributorAuthor

  19. melvincarvalho commented on Dec 14, 2018

    @melvincarvalho
    melvincarvalho
    on Dec 14, 2018
    Contributor

    Not sure what you mean, @melvincarvalho

    @kjetilk are you aware that files created on the server such as card will no longer be named card, but rather, card$.ttl (iirc), in version 5?

    I think that's not the only case and applies in other areas such as inboxes.

    This is a change from other versions of node solid server, so it might be worth letting people know?

  20. megoth commented on Dec 14, 2018

    @megoth
    megoth
    on Dec 14, 2018
    Contributor

    I thought nothing changed for pod owners? Old HTML doesn’t have the meta tag, so should’ve stay the same.

    That is not the way the script has been written, there are three scenarios:

    1. No meta-tag for solid-allow-automatic-updates --> do update
    2. solid-allow-automatic-updates is set to true --> do update
    3. solid-allow-automatic-updates is set to false (or anything beside true really) --> do not update

    Point 1 should maybe be "do not update"? It's very easy to fix, if that's the case, but I assumed most people, also people with older PODs wanted to update their index.html unless stated otherwise? I'm sorry if this was faulty assumption.

  21. kjetilk commented on Dec 14, 2018

    @kjetilk
    kjetilk
    on Dec 14, 2018
    Member

    Not sure what you mean, @melvincarvalho

    @kjetilk are you aware that files created on the server such as card will no longer be named card, but rather, card$.ttl (iirc), in version 5?

    I think that's not the only case and applies in other areas such as inboxes.

    This is a change from other versions of node solid server, so it might be worth letting people know?

    Oh yes, but that's in there with an extensive description. I thought you meant that there were changes to the HTTP interface, but lost the context there. So, that should be OK.

  22. RubenVerborgh commented on Dec 16, 2018

    @RubenVerborgh
    RubenVerborgh
    on Dec 16, 2018
    ContributorAuthor
    1. No meta-tag for `solid-allow-automatic-updates` --> do update

    My opinion is that we shouldn't touch it—perhaps unless it is identical to the previous template (but the check for that is a bit more involved, as it involves filling out fields in that template).

  23. melvincarvalho commented on Dec 17, 2018

    @melvincarvalho
    melvincarvalho
    on Dec 17, 2018
    Contributor

    I'm good with the script changing the system generated index.html file, but only the index.html file. A few reasons for this.

    • Eventually I think the index file will go away and be replaced with a client side app, I think
    • It was only intended as a temporary stop gap I believe
    • People have already complained that it was showing email addresses, and I think that is a valid concern
    • There is an opt out mechanism

    It strikes me that pod admins, will ultimately make that decision on a per server basis, in the spirit of owning your own data. It may be possible to add a swtich for this, or that might be overkill

  24. melvincarvalho commented on Dec 17, 2018

    @melvincarvalho
    melvincarvalho
    on Dec 17, 2018
    Contributor

    perhaps unless it is identical to the previous template

    This is a nice idea!

  25. melvincarvalho commented on Dec 17, 2018

    @melvincarvalho
    melvincarvalho
    on Dec 17, 2018
    Contributor

    the check for that is a bit more involved, as it involves filling out fields in that template

    That would do it. However perhaps another heuristic could be to check the time stamp relative to another system generated file, to ensure it hasnt changed.

    Or maybe even created time vs modified time? I dont know how reliable that is.

  26. megoth commented on Dec 17, 2018

    @megoth
    megoth
    on Dec 17, 2018
    Contributor

    the check for that is a bit more involved, as it involves filling out fields in that template

    That would do it. However perhaps another heuristic could be to check the time stamp relative to another system generated file, to ensure it hasnt changed.

    Or maybe even created time vs modified time? I dont know how reliable that is.

    I've created #1030 for discussing this issue further, as it kind of strays from the main topic of this issue.

  27. kjetilk commented on Mar 19, 2019

    @kjetilk
    kjetilk
    on Mar 19, 2019
    Member

    I noticed some differences to the server setup that wasn't on my radar:

      "emailHost": 
  "emailPort": 
 "emailAuthUser": 
  "emailAuthPass":

    I think we need to have them in the changelog.

  28. michielbdejong
    added
    triageIssues that need team review
    and removed
    triageIssues that need team review
    on Mar 25, 2019

  29. michielbdejong commented on Mar 25, 2019

    @michielbdejong
    michielbdejong
    on Mar 25, 2019
    Member

    part of #1145

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentation

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions