[docs-only] add toc to changelog

mmattel commented 10 months ago

Description

Adds table of contents to the top of the CHANGELOG.md file.

Anchor links in markdown are generated from the content of the header according to the following rules:

All text is converted to lowercase.
All non-word text (e.g., punctuation, HTML) is removed.
All spaces are converted to hyphens.
Two or more hyphens in a row are converted to one.
If a header with the same ID has already been generated, a unique incrementing number is appended, starting at 1.
All changelogs for 2.x and below have a main entrance link

Related Issue

Relates to https://github.com/owncloud/docs/issues/4901
Changes copied from: https://github.com/owncloud/ocis/pull/7691

Related Issues

App:

[ ] Added changelog files for the fixed issues in folder changelog/unreleased. More info here

QA

jesmrec commented 10 months ago

How do this affect Calens?

mmattel commented 10 months ago

Run locally, works nicely 😄

mmattel commented 10 months ago

How do this affect Calens?

We add in all products where we publish changelogs a table of contents. This makes it much easier to read. In addition, the changelog is pulled automatically to our homepage into the changelog section and also shown there, now with a greatly improved readbility.

michaelstingl commented 10 months ago

@mmattel could you post the desktop TOC to get an idea?

michaelstingl commented 10 months ago

2.18.0 to 2.20.0 not included?

Also include the earlier versions?

curl -s "https://raw.githubusercontent.com/owncloud/android/master/CHANGELOG.md" | grep -e "Changelog for" -e "## " | grep -v " beta "
Changelog for ownCloud Android Client [unreleased] (UNRELEASED)
Changelog for ownCloud Android Client [4.1.1] (2023-10-18)
Changelog for ownCloud Android Client [4.1.0] (2023-08-23)
Changelog for ownCloud Android Client [4.0.0] (2023-05-29)
Changelog for ownCloud Android Client [3.0.4] (2023-03-07)
Changelog for ownCloud Android Client [3.0.3] (2023-02-13)
Changelog for ownCloud Android Client [3.0.2] (2023-01-26)
Changelog for ownCloud Android Client [3.0.1] (2022-12-21)
Changelog for ownCloud Android Client [3.0.0] (2022-12-12)
Changelog for ownCloud Android Client [2.21.2] (2022-09-07)
Changelog for ownCloud Android Client [2.21.1] (2022-06-15)
Changelog for ownCloud Android Client [2.21.0] (2022-06-07)
Changelog for ownCloud Android Client [2.20.0] (2022-02-16)
Changelog for ownCloud Android Client [2.19.0] (2021-11-15)
Changelog for ownCloud Android Client [2.18.3] (2021-10-27)
Changelog for ownCloud Android Client [2.18.1] (2021-07-20)
Changelog for ownCloud Android Client [2.18.0] (2021-05-24)
## 2.17 (March 2021)
## 2.16.0 (January 2021)
## 2.15.3 (October 2020)
## 2.15.2 (September 2020)
## 2.15.1 (July 2020)
## 2.15 (June 2020)
## 2.14.2 (January 2020)
## 2.14.1 (December 2019)
## 2.14 (December 2019)
## 2.13.1 (October 2019)
## 2.13 (September 2019)
## 2.12 (August 2019)
## 2.11.1 (June 2019)
## 2.11 (June 2019)
## 2.10.1 (April 2019)
## 2.10.0 (March 2019)
## 2.9.3 (November 2018)
## 2.9.2 (November 2018)
## 2.9.1 (November 2018)
## 2.9.0 (November 2018)
## 2.8.0 (July 2018)
## 2.7.0 (April 2018)
## 2.6.0 (February 2018)
## 2.5.0 (October 2017)
## 2.4.0 (May 2017)
## 2.3.0 (March 2017)
## 2.2.0 (December 2016)
## 2.1.1 (September 2016)
## 2.1.0 (August 2016)
## 2.0.1 (June 2016)
## 2.0.0 (April 2016)
## 1.9.1 (February 2016)
## 1.9.0 (December 2015)
## 1.8.0 (September 2015)
## 1.7.2 (July 2015)
## 1.7.1 (April 2015)
## 1.7.0 (February 2015)

mmattel commented 10 months ago

Also include the earlier versions...

See: https://github.com/owncloud/ios-app/pull/1287#issuecomment-1804200242

owncloud / android