gitea/helm-chart
45
55
Fork 126
Code Issues 32 Pull Requests 8 Actions Releases 87 Activity

Restructure changelog/upgrading approach #331

Merged
luhahn merged 9 commits from justusbunsi/helm-chart:restructure-changes-247 into master 2022-07-15 17:27:49 +00:00
Conversation 1 Commits 9 Files Changed 1 +182 -179
justusbunsi commented 2022-06-25 17:57:41 +00:00
Member
Copy Link

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

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.
justusbunsi added the
kind
docs
 label 2022-06-25 17:57:41 +00:00
justusbunsi added 5 commits 2022-06-25 17:57:43 +00:00
Move major/breaking changelog to the bottom 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
e25d44db12
Improve the reading flow of upgrading notes 
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.

I've 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.

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
4905ed9d88
Fix section indents 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
e86ead3897
Fix grammar 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
7300d73f68
justusbunsi added 1 commit 2022-06-25 18:27:04 +00:00
Fix quick links 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
cfbf1575ed
justusbunsi added 1 commit 2022-07-08 19:45:16 +00:00
Merge branch 'master' into restructure-changes-247
All checks were successful
continuous-integration/drone/pr Build is passing
Details
44033c2865
justusbunsi added 1 commit 2022-07-09 21:02:39 +00:00
Merge branch 'master' into restructure-changes-247
All checks were successful
continuous-integration/drone/pr Build is passing
Details
b8c0dc6f64
luhahn reviewed 2022-07-11 16:14:17 +00:00
luhahn left a comment
Member
Copy Link

small something we could improve here, optionally though

small something we could improve here, optionally though
README.md Outdated
@ -640,3 +471,3 @@
```
:warning: Some options are just flags and therefore don't any values. If they
⚠ Some options are just flags and therefore don't any values. If they
luhahn commented 2022-07-11 16:13:54 +00:00
Member
Copy Link

don't any values -> don't have any values

not introduced by your changes though :)

don't any values -> don't have any values not introduced by your changes though :)
justusbunsi marked this conversation as resolved
justusbunsi added 1 commit 2022-07-12 07:19:23 +00:00
Apply suggested changes 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
d2333ce3c9
justusbunsi commented 2022-07-12 07:22:08 +00:00
Author
Member
Copy Link

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

@luhahn Changes applied. The "no-value" list for LDAP is subject to change with #333, but typos are never awesome. ?
luhahn approved these changes 2022-07-12 15:08:48 +00:00
techknowlogick approved these changes 2022-07-15 15:25:06 +00:00
luhahn merged commit 32735ed4df into master 2022-07-15 17:27:49 +00:00
justusbunsi deleted branch restructure-changes-247 2024-03-10 15:15:41 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
luhahn
techknowlogick
Labels
Clear labels   
has
backport

  
in progress

   
invalid
  
kind
breaking

  
kind
bug

  
kind
build

  
kind
dependency

  
kind
deployment

  
kind
docs

  
kind
enhancement

  
kind
feature

  
kind
lint

  
kind
proposal

  
kind
question

  
kind
refactor

  
kind
security

  
kind
testing

  
kind
translation

  
kind
ui

  
need
backport

  
priority
critical

  
priority
low

  
priority
maybe

  
priority
medium

  
reviewed
duplicate

  
reviewed
invalid

  
reviewed
wontfix

  
skip-changelog
  
status
blocked

  
status
needs-feedback

  
status
needs-reviews

  
status
wip

  
upstream
gitea

  
upstream
other

No Label
has
backport
in progress
invalid
kind
breaking
kind
bug
kind
build
kind
dependency
kind
deployment
kind
docs
kind
enhancement
kind
feature
kind
lint
kind
proposal
kind
question
kind
refactor
kind
security
kind
testing
kind
translation
kind
ui
need
backport
priority
critical
priority
low
priority
maybe
priority
medium
reviewed
duplicate
reviewed
invalid
reviewed
wontfix
skip-changelog
status
blocked
status
needs-feedback
status
needs-reviews
status
wip
upstream
gitea
upstream
other
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/helm-chart#331
No description provided.
Delete Branch "justusbunsi/helm-chart:restructure-changes-247"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?