docs icon indicating copy to clipboard operation
docs copied to clipboard

https://owncloud.org/changelog/server/ improvements

Open jnweiger opened this issue 4 years ago • 8 comments

I'd like to suggest the following changes to how we present the changelog

  • Currently https://owncloud.org/changelog/server starts with a link to owncloud 9. I find it a confusing start, when follwing a link from a 10.4.0 annoucement. It should go to the bottom. It follows logically right after the 10.0.0 changelog section.

  • The UNRELEASED section should be collaped by default. If users want to know about the future, they can expose the section. This way the changelog would start with released changes, which is more relevant to the end users.

  • All H1 headings have a version number with an . A name="VERSION" should be added, so that e.g. https://owncloud.org/changelog/server/#10.4.0 would work. That is most helpful for mailings and release notes.

jnweiger avatar Mar 05 '20 22:03 jnweiger

Yes, I absolutely agree with these improvements. Still, this is not part of the docs. Will put this into the right channels :)

pmaier1 avatar Mar 06 '20 09:03 pmaier1

Thanks @jnweiger for the improvements. I agree but there are certain limitations. The Changelog page is automatically created based on https://raw.githubusercontent.com/owncloud/core/master/CHANGELOG.md Wordpress fetches the contents once an hour, parses the markdown code, converts it to HTML and saves it in the WP DB. Thus, only elements/markup existing in markdown are possible on this page. Collapsing elements etc. is not one of them.

Currently https://owncloud.org/changelog/server starts with a link to owncloud 9. I find it a confusing start, when follwing a link from a 10.4.0 annoucement. It should go to the bottom. It follows logically right after the 10.0.0 changelog section.

This is not part of the changelog.md file, so it's changeable in Wordpress. We put it above because noone will find the link if it is a the bottom of the (looong) changelog page. If we still want to change that I can do this.

All H1 headings have a version number with an . A name="VERSION" should be added, so that e.g. https://owncloud.org/changelog/server/#10.4.0 would work. That is most helpful for mailings and release notes.

As mentioned above this is parsed from the .md file. @micbar is the right person to talk to about that.

I know it's unfortunate to have those limitations but the HUGE benefit is that noone has to manually write and keep track of the changelog page. As long we can use the automatic parsing and don't run into bigger problems I'd always prefer this method.

hurradieweltgehtunter avatar Mar 06 '20 10:03 hurradieweltgehtunter

All H1 headings have a version number with an . A name="VERSION" should be added, so that e.g. https://owncloud.org/changelog/server/#10.4.0 would work. That is most helpful for mailings and release notes.

You mean the github links on the version? https://github.com/owncloud/core/compare/v10.3.2...v10.4.0 this is the github history betweed these two tags.

If you want an anchor link, we need to investigate how we can pass it from markdown to html

micbar avatar Mar 06 '20 13:03 micbar

Yep automation is key -> forget the collapsing idea. V9 link underneath is preferable to me even though the page is long, imho. name anchor links to be added by the generator scripts if possible, please.

jnweiger avatar Mar 06 '20 16:03 jnweiger

V9 link was moved to the bottom anchor links should work like explained here: https://gist.github.com/asabaylus/3071099

hurradieweltgehtunter avatar Mar 09 '20 14:03 hurradieweltgehtunter

@jnweiger now the latest release is on top. Better?

voroyam avatar Mar 09 '21 01:03 voroyam

image

voroyam avatar Mar 09 '21 01:03 voroyam

Much better. Thanks!

jnweiger avatar May 04 '21 11:05 jnweiger