Tweak README text and formatting #1646
Conversation
and set the new version number to v6 Signed-off-by: RD WebDesign <[email protected]>
Signed-off-by: RD WebDesign <[email protected]>
mainly format changes, removal of trailing spaces, addition or removal of line breaks and some text corrections Signed-off-by: RD WebDesign <[email protected]>
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
Signed-off-by: RD WebDesign <[email protected]>
|
Conflicts have been resolved. |
README.md
Outdated
| > [!CAUTION] | ||
| > | ||
| > ## !!! THIS VERSION CONTAINS BREAKING CHANGES | ||
| > **v6 has been entirely redesigned from the ground up and contains many breaking changes.** |
There was a problem hiding this comment.
| > **v6 has been entirely redesigned from the ground up and contains many breaking changes.** | |
| > **v[ChangeMeBeforeTagging] has been entirely redesigned from the ground up and contains many breaking changes.** |
I suppose v[ChangeMeBeforeTagging] is there as Docker is more concerned about tags in the format YYYY.MM.X. The tag cannot be foreseen as there is no fixed v6 release date.
There was a problem hiding this comment.
I agree we need a better text here, but the current paragraph is not wrong (maybe just incomplete).
v6 is an entirely redesigned Pi-hole. Every v6 tag will contain breaking changes compared to v5 tags.
We probably need to include both: v6 and a tag.
There was a problem hiding this comment.
I changed the text a little bit to warn that replacing older images (2024.07.0 and earlier) with newer images will cause irreversible changes to config files in the volumes.
I know that docker is related to image tags, but our image tags doesn't contain Pi-hole version number. It is necessary to reinforce that new images will use Pi-hole v6 to avoid confusion.
There was a problem hiding this comment.
After the recent commits, do you still has any suggestions?
Signed-off-by: RD WebDesign <[email protected]>
Signed-off-by: RD WebDesign <[email protected]>
Co-authored-by: RD WebDesign <[email protected]> Signed-off-by: Adam Warner <[email protected]>
Description
Mainly format changes, removal of trailing spaces, addition or removal of line breaks and some text corrections.
Using some markdown alerts to emphasize critical information.