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 16 commits into
base: release/v6.0
Choose a base branch
from
Open

Update docs to remove/replace outdated references #1099

wants to merge 16 commits into from
+170 −1,064

Conversation

PromoFaux
Copy link
Member

@PromoFaux PromoFaux commented Sep 24, 2024 •
edited by rdwebdesign
Loading

What does this PR aim to accomplish?:

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

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 67f7d0f
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/6720c75879758900087e24d2
😎 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
@PromoFaux
Copy link
Member Author

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

yubiuser
yubiuser reviewed Oct 6, 2024
View reviewed changes
docs/database/query-database.md Outdated Show resolved Hide resolved
docs/ftldns/blockingmode.md Show resolved Hide resolved
docs/main/pihole-command.md Outdated Show resolved Hide resolved
docs/main/pihole-command.md Outdated Show resolved Hide resolved
docs/regex/pi-hole.md Outdated Show resolved Hide resolved
@PromoFaux @yubiuser
Update docs/database/query-database.md
3f436cc 
Co-authored-by: yubiuser <[email protected]>
Signed-off-by: Adam Warner <[email protected]>
@rdwebdesign
Copy link
Member

@PromoFaux

Since you are removing/replacing outdated references, this table needs to be updated to include port 443, remove telnet port and remove lighttpd references.
Or do you think this deserves a separate PR?

@PromoFaux
white/black -> allow/deny
e68cabf 
Signed-off-by: Adam Warner <[email protected]>
@PromoFaux
Copy link
Member Author

Or do you think this deserves a separate PR?

Might as well make this a general purpose "bring things up to date" PR!

@PromoFaux
Update/remove lighttpd/php references. Remove the links to community …
31aa2ab 
…guides for nginx/caddy/traefik until such time that they can be updated for v6

Signed-off-by: Adam Warner <[email protected]>
yubiuser
yubiuser reviewed Oct 20, 2024
View reviewed changes
docs/database/domain-database/groups.md Outdated Show resolved Hide resolved
docs/database/query-database.md Show resolved Hide resolved
docs/guides/misc/allowlist-denylist.md Outdated Show resolved Hide resolved
docs/main/pihole-command.md Show resolved Hide resolved
docs/main/prerequisites.md Outdated Show resolved Hide resolved
docs/main/prerequisites.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@PromoFaux
grammar?
08b9ddd 
Signed-off-by: Adam Warner <[email protected]>
@PromoFaux
Remove webserver community guides - they're outdated and it is probab…
49c32e2 
…ly time for a refresh in any case - these can come later

Signed-off-by: Adam Warner <[email protected]>
@rdwebdesign
Copy link
Member

About the Guides section:

You removed the web server guides. Maybe we need to update or remove some other guides too.

I just saw a discourse topic related to Unbound guide. Apparently it needs some changes.

@PromoFaux
Copy link
Member Author

I think certainly the unbound one could be updated - but for this PR I'd like to stick to removing/updating things as they pertain specifically to V6

DL6ER
DL6ER reviewed Oct 28, 2024
View reviewed changes
docs/ftldns/dnsmasq_warn.md Outdated Show resolved Hide resolved
docs/guides/misc/benchmark.md
```

in `/etc/pihole/pihole-FTL.conf` and running `sudo pihole restartdns` (see also [here](../../ftldns/configfile.md/#dbfile)).
The long-term database can be disabled running `pihole-FTL --config files.database ""`
Copy link
Member

Choose a reason for hiding this comment

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

I did just realize that this disabled everything from the database, network table, for instance. We should test how the API behaves, I guess we may see many error 500s which seems undesirable... I don't think we have tested this configuration on conjunction with the web interface (at least, not me).

Copy link
Member

Choose a reason for hiding this comment

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

Setting the maximum number of days to retain in the database to zero should have the save effect (sorting no queries) without such adverse effects.

Copy link
Member Author

Choose a reason for hiding this comment

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

Is there a suggestion for some alternative wording here?

Copy link
Member

Choose a reason for hiding this comment

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

Suggestion 1:

Suggested change
The long-term database can be disabled running `pihole-FTL --config files.database ""`
The same effect can be achieved if you set the *maximum number of days to retain in the database* to zero, running `pihole-FTL --config database.maxDBdays 0`.

Suggestion 2:

Suggested change
The long-term database can be disabled running `pihole-FTL --config files.database ""`
The same effect can be achieved if you set `database.maxDBdays` to zero, running `pihole-FTL --config database.maxDBdays 0`. This will change the maximum number of days the database will keep to zero, resulting in no queries being stored.

@PromoFaux @DL6ER
Update docs/ftldns/dnsmasq_warn.md
67f7d0f 
Co-authored-by: Dominik <[email protected]>
Signed-off-by: Adam Warner <[email protected]>
rdwebdesign
rdwebdesign requested changes Oct 29, 2024
View reviewed changes
docs/guides/misc/benchmark.md
```

in `/etc/pihole/pihole-FTL.conf` and running `sudo pihole restartdns` (see also [here](../../ftldns/configfile.md/#dbfile)).
The long-term database can be disabled running `pihole-FTL --config files.database ""`
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion 1:

Suggested change
The long-term database can be disabled running `pihole-FTL --config files.database ""`
The same effect can be achieved if you set the *maximum number of days to retain in the database* to zero, running `pihole-FTL --config database.maxDBdays 0`.

Suggestion 2:

Suggested change
The long-term database can be disabled running `pihole-FTL --config files.database ""`
The same effect can be achieved if you set `database.maxDBdays` to zero, running `pihole-FTL --config database.maxDBdays 0`. This will change the maximum number of days the database will keep to zero, resulting in no queries being stored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DL6ER DL6ER DL6ER left review comments

@rdwebdesign rdwebdesign rdwebdesign requested changes

@yubiuser yubiuser Awaiting requested review from yubiuser

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

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