Restructure changelog/upgrading approach #331

2022-06-25T17:57:41Z

justusbunsi commented

2022-06-25 17:57:41 +00:00

(Migrated from gitea.com)

Description of the change

Mostly, this change just moves the changelog to the bottom of the README which helps new users to see the actual documentation. As the structure for the changes itself is slightly different, there are some changes in wording so that it still makes sense. But mostly structural changes.

The change within the dependency section is due to a broken link since auto-generating the parameters section. Now there are links to every dependency related parameters.

Benefits

It helps us to maintain a clear structure for the README of this project.

Possible drawbacks

Our users are currently trained to look at the top of the document to see the changes. They now have to scroll down or use the quick link from installation section.

Applicable issues

fixes #247

Additional information

Every version section starts with a disclaimer right now. This is duplicated and might hide important text due to its existence. A centralized intruduction at top of the upgrading section tells the reader what to expect from that whole section.

I've also noticed that on ArtifactHub the emotes are not rendered correctly. So I replaced them with the actual ones and reduced their usage. That way it better highlights those parts the reader must not miss.

### Description of the change Mostly, this change _just_ moves the changelog to the bottom of the README which helps new users to see the actual documentation. As the structure for the changes itself is slightly different, there are some changes in wording so that it still makes sense. But mostly structural changes. The change within the dependency section is due to a broken link since auto-generating the parameters section. Now there are links to every dependency related parameters. ### Benefits It helps us to maintain a clear structure for the README of this project. ### Possible drawbacks Our users are currently trained to look at the top of the document to see the changes. They now have to scroll down or use the quick link from _installation_ section. ### Applicable issues - fixes #247 ### Additional information Every version section starts with a disclaimer right now. This is duplicated and might hide important text due to its existence. A centralized intruduction at top of the upgrading section tells the reader what to expect from that whole section. I've also noticed that on ArtifactHub the emotes are not rendered correctly. So I replaced them with the actual ones and reduced their usage. That way it better highlights those parts the reader must not miss.

luhahn (Migrated from gitea.com) reviewed 2022-07-11 16:13:54 +00:00

luhahn (Migrated from gitea.com) left a comment

small something we could improve here, optionally though

justusbunsi commented

2022-07-12 07:22:08 +00:00

(Migrated from gitea.com)

@luhahn Changes applied. The "no-value" list for LDAP is subject to change with #333, but typos are never awesome. ?

luhahn (Migrated from gitea.com) approved these changes 2022-07-12 15:08:48 +00:00

techknowlogick (Migrated from gitea.com) approved these changes 2022-07-15 15:25:06 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lunny/helm-chart#331