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.

Sign up for GitHub

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

Jump to bottom

Rewrite the README to reflect the v6 changes #3109

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

Rewrite the README to reflect the v6 changes #3109

wants to merge 5 commits into from

Conversation

rdwebdesign
Copy link
Member

Note: This PR depends on the graphics repo PR to include the new images.

What does this PR aim to accomplish?

Change the README file to reflect the v6 changes, showing the new features and removing the deprecated ones.

How does this PR accomplish the above?

Adding new images a and changing texts where needed.

By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.
  • I have read the above and my PR is ready for review. Check this box to confirm

@rdwebdesign rdwebdesign changed the base branch from development-v6 to development September 3, 2024 19:13
@rdwebdesign rdwebdesign force-pushed the v6_README branch 3 times, most recently from aacc4a0 to cf09b42 Compare September 10, 2024 17:28
@rdwebdesign rdwebdesign marked this pull request as ready for review September 10, 2024 17:31
@rdwebdesign rdwebdesign requested a review from a team September 10, 2024 17:31
yubiuser
yubiuser requested changes Sep 11, 2024
View reviewed changes
Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

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

What is the browser-stack-badge for? I don't think we use that service...

__

I would remove the link to disourse on how to access the web interface.

__

We can now also access via https

Remove "forgot your password?"

Passwort protection - maybe add 2FA + Screenshot

README.md Show resolved Hide resolved
@rdwebdesign
Copy link
Member Author

What is the browser-stack-badge for?

I really don't know.
This badge was there since a long time ago. I will remove it because we don't use this service.

@rdwebdesign
Copy link
Member Author

What is the browser-stack-badge for? I don't think we use that service...

  • Done: badge removed

I would remove the link to disourse on how to access the web interface.

  • Done: Agree... link removed

We can now also access via https

  • Done: note added to make the use of http/https clear;

Remove "forgot your password?"

  • Done: text removed

Passwort protection - maybe add 2FA + Screenshot

  • I will change the "login screen" image in a future PR.

@rdwebdesign
Rewrite the README to reflect the v6 changes
108179a 
- Change the initial logo block:
  - simplify the logo code using a SVG logo instead of 2 PNG files;
  - the new SVG file contains `prefers-color-scheme` CSS rule to change
    text color depending on the user preferences (dark/light modes)
  - add some links: Pi-hole site, Discourse, Documetation and Donate

- Remove a broken link to Pi-hole store

- Use new images and change a few texts to show v6 features

- Remove "Audit log" and "Debug log" sections (they don't exist in v6)

Signed-off-by: RD WebDesign <[email protected]>
@rdwebdesign
More changes:
212e12e 
- Replace some more images (v6 version);
- Add text description for settings;
- Use TEX code to highlight some text labels;

Signed-off-by: RD WebDesign <[email protected]>
@rdwebdesign
Implementing suggestions:
3814cd3 
- remove browserstack badge;
- remove unnecessary texts and links;
- add a note about http/https access;

Signed-off-by: RD WebDesign <[email protected]>
@rdwebdesign
Change icon sizes and alignment (PayPal and Bitcoin)
4c990b2 
Signed-off-by: RD WebDesign <[email protected]>
yubiuser
yubiuser previously approved these changes Sep 11, 2024
View reviewed changes
@PromoFaux
Copy link
Member

This badge was there since a long time ago. I will remove it because we don't use this service.

We might not have used it recently, but we have a sponsored plan with the service, so perhaps put it back for the time being (I think it was a condition of the plan)

@rdwebdesign
Copy link
Member Author

I will wait until we decide what will happen with #3139.

@yubiuser
Copy link
Member

sponsored plan with the service

Do you want to re-enable the service to check the web interface?

@rdwebdesign
Readd the browserstack add
318893f 
Signed-off-by: RD WebDesign <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yubiuser yubiuser yubiuser left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Pi-hole v6.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rdwebdesign @PromoFaux @yubiuser