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

Update docs to remove/replace outdated references #1099

Open
wants to merge 5 commits into
base: release/v6.0
Choose a base branch
from
Open

Update docs to remove/replace outdated references #1099

wants to merge 5 commits into from

Conversation

PromoFaux
Copy link
Member

What does this PR aim to accomplish?:

Companion PR to pi-hole/pi-hole#5779

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)
  • I have read the above and my PR is ready for review. Check this box to confirm

@PromoFaux PromoFaux mentioned this pull request Sep 24, 2024
Closed
1 task
@netlify Netlify
Copy link

netlify bot commented Sep 24, 2024 •
edited
Loading

✅ Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 282cf1a
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/66fdae0506886c0008e8b5e1
😎 Deploy Preview https://deploy-preview-1099--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yubiuser
Copy link
Member

Would you mind checking all the other pihole flags? E.g. pihole -b is gone as well....

@rdwebdesign
Copy link
Member

This page will also need to be changed: https://docs.pi-hole.net/group_management/example/

image

@github-actions GitHub Actions
Copy link
Contributor

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

@PromoFaux PromoFaux force-pushed the remove-restartdns branch 2 times, most recently from 3813ae0 to e3d537b Compare October 2, 2024 18:56
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Conflicts have been resolved.

@PromoFaux
Update benchmark.md to reflect removed restartdns command and also up…
807e522 
…date config setting instructions

Signed-off-by: Adam Warner <[email protected]>
@PromoFaux PromoFaux changed the title remove restartdns command from docs Update docs to remove/replace outdated references Oct 2, 2024
yubiuser
yubiuser reviewed Oct 2, 2024
View reviewed changes
docs/ftldns/blockingmode.md Outdated
@@ -9,7 +9,7 @@ Pi-hole *FTL*DNS currently supports the following modes for blocking queries:
Each mode has their advantages and drawbacks which will be discussed in detail below.

!!! note
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole with `pihole restartdns`.
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).
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
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole.toml`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).

Copy link
Member Author

Choose a reason for hiding this comment

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

Already coming in the next commit... :)

Copy link
Member

Choose a reason for hiding this comment

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

Happy to wait until you request review :)

Copy link
Member Author

Choose a reason for hiding this comment

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

I figured I would go down a bit of a rabbit hole and try to update some of the outdated sections, too. In two minds about what to do with the ftldns/configfile/ page...

  1. Copy paste the current pihole.toml into this page as an online reference (with a reference to refer to the actual file for any up to date information
  2. Remove the page entirely
  3. (I know, I said two minds) put a small blurb about the existence of pihole.toml and that it is fully commented to describe each section (or to use the web interface)

Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

I would go for three and add a link to https://ftl.pi-hole.net/master/docs/#get-/config (currently development) if users only want to get a list of possible config options.

@PromoFaux
Copy link
Member Author

@yubiuser - ready for a review at this stage. There may be more to come, but I'm tired....

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

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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