search

noi-techpark / odh-docs

Open Data Hub (http://opendatahub.com/) Documentation
http://opendatahub.readthedocs.io/en/latest/index.html
4 stars 4 forks source link

Issue 194 add changelog #202

Closed stefanodavid closed 3 years ago

stefanodavid commented 3 years ago

I expect this will need some work after merging #199 (closes #194)

Piiit commented 3 years ago

@stefanodavid Cool. What would you think, if we then remove the changelog entries in each section and just have this changelog linked? In some articles the initial changelog entries are too long in my opinion and thus distract from the "real" content. What do you think?

stefanodavid commented 3 years ago

@Piiit thanks for the feedback. Yes,you're right: Some sections (e.g., datasets) have now a quite extensive changelog. However, I think we should not remove all the entries; surely the oldest are quite useless, but we should keep the 2 or 3 more recent entries (especially for someone who comes regularly back to check some part of the docs. If you agree I will clean these sections as part of this PR.

Piiit commented 3 years ago

..., but we should keep the 2 or 3 more recent entries (especially for someone who comes regularly back to check some part of the docs.

Yes, that is a good compromise.

If you agree I will clean these sections as part of this PR.

Please, go ahead.

Piiit commented 3 years ago

@stefanodavid I make it a draft (new github feature) then, such that no one accidentally merges it, before you are done

stefanodavid commented 3 years ago

(I think) I'll be working on this today or tomorrow.

mrabans commented 3 years ago

@Piiit thanks for the feedback. Yes,you're right: Some sections (e.g., datasets) have now a quite extensive changelog. However, I think we should not remove all the entries; surely the oldest are quite useless, but we should keep the 2 or 3 more recent entries (especially for someone who comes regularly back to check some part of the docs. If you agree I will clean these sections as part of this PR.

What if the changelog would be collapsible?

stefanodavid commented 3 years ago

@Piiit, all I took a look at the code and removed a couple of entries, namely all those with an "old" format (like 2020-May) or where their list was too long. The latter happened only in one place (datasets) but the effect was indeed not good.

I also decided as a policy to keep in-text changelog entries for at most one year, then remove them. I think this is a good solution for now.

@mrabans IMHO it makes little sense to keep a collapsible changelog in-text, since we now keep a real and full changelog in a dedicated section, but happy to discuss this.

@Piiit I move this to review, feel free to suggest more changes if you have some.

mrabans commented 3 years ago

@mrabans IMHO it makes little sense to keep a collapsible changelog in-text, since we now keep a real and full changelog in a dedicated section, but happy to discuss this.

alright, fine for me

stefanodavid commented 3 years ago

@Piiit @bertolla @RudiThoeni can someone merge this? Thanks!