Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak README text and formatting #1646

Open
wants to merge 4 commits into
base: development
Choose a base branch
from
Open

Conversation

rdwebdesign
Copy link
Member

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.

and set the new version number to v6

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]>
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link

Conflicts have been resolved.

@rdwebdesign rdwebdesign marked this pull request as ready for review September 25, 2024 16:32
@rdwebdesign rdwebdesign requested a review from a team September 25, 2024 16:32
@rdwebdesign rdwebdesign added the v6 label Sep 25, 2024
> [!CAUTION]
>
> ## !!! THIS VERSION CONTAINS BREAKING CHANGES
> **v6 has been entirely redesigned from the ground up and contains many breaking changes.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **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.

Copy link
Member Author

@rdwebdesign rdwebdesign Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants