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

Pi-hole v6.0 documentation #338

Draft
wants to merge 245 commits into
base: master
Choose a base branch
from
Draft

Pi-hole v6.0 documentation #338

wants to merge 245 commits into from

Conversation

DL6ER
Copy link
Member

@DL6ER DL6ER commented Jun 16, 2020

It will be simpler to maintain the API documentation while the API is developed instead of doing this in one big batch at the end.

@DL6ER DL6ER added this to the v6.0 milestone Jun 16, 2020
@netlify
Copy link

netlify bot commented Jun 16, 2020 •
edited
Loading

✅ Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 7d29f90
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/66f7e474a4e0d00008cd8721
😎 Deploy Preview https://deploy-preview-338--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.

@dschaper dschaper mentioned this pull request Mar 6, 2021
Merged
@snyk-bot snyk-bot mentioned this pull request Oct 27, 2021
Open
This was referenced Dec 2, 2021
Open
Open
Open
@github-actions
Copy link
Contributor

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

@yubiuser
We don't offer setting a static IP anymore
3b970d0 
Signed-off-by: Christian König <ckoenig@posteo.de>
DL6ER added 17 commits July 8, 2023 13:40
@DL6ER
Pi-hole v6.0 API description for /api/dns
6446bcb 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Move white- and blacklist endpoints one level up
e601281 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Rename /api/dns/status -> /api/dns/blocking and move black- and white…
81cc07c 
…list endpoints one level up

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Directly add JSON payload instead of sourceing from file
6cc622f 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add documentation for single GET requests
febfd6a 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
The domainlist endpoints now return the same data that would be retur…
efa4564 
…ned via GET on success. This brings a more uniform experience.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Rename /api/dns/cacheinfo to /api/dns/cache
1a5de9b 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add details for fields in API responses.
df4d3e2 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Use inline highlighting
1471058 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add API->authentication documentation
6420a58 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Use pymdownx.highlight instead of the deprecated codehilite
3b36434 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Update documentation
bba1235 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Update DNS cache page
d058074 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
POST should not include the target to get pushed
64bbfe7 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Remove obsolete API documentation. This is to be replaced by the Open…
a7a5cb1 
…API documentation that ships with FTL

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Remove obsolete domain_audit table documentation
260e322 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add domain priorities concerning what is to be blocked and allowed
3e3d72c 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@github-actions GitHub Actions
Copy link
Contributor

Conflicts have been resolved.

DL6ER and others added 6 commits September 14, 2024 13:57
@DL6ER
Add new QUERY_EXTERNAL_BLOCKED_EDE15 query status
3a2dcc9 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Merge pull request #1094 from pi-hole/new/edns_reasoning
1de2217 
Add new QUERY_EXTERNAL_BLOCKED_EDE15 query status
@dependabot
Bump actions/setup-node in the github_action-dependencies group
ac1e418 
Bumps the github_action-dependencies group with 1 update: [actions/setup-node](https://github.com/actions/setup-node).


Updates `actions/setup-node` from 4.0.3 to 4.0.4
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v4.0.3...v4.0.4)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
Bump mkdocs-material from 9.5.34 to 9.5.36 in the pip-dependencies group
cea418a 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.34 to 9.5.36
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.34...9.5.36)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
@yubiuser
Merge pull request #1096 from pi-hole/dependabot/github_actions/relea…
cc0fb6f 
…se/v6.0/github_action-dependencies-916932a5fa

Bump actions/setup-node from 4.0.3 to 4.0.4 in the github_action-dependencies group
@yubiuser
Merge pull request #1098 from pi-hole/dependabot/pip/release/v6.0/pip…
6941488 
…-dependencies-73612938eb

Bump mkdocs-material from 9.5.34 to 9.5.36 in the pip-dependencies group
PromoFaux and others added 16 commits September 25, 2024 12:04
@PromoFaux
Add some information about building the docker image locally
6e06b39 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Tweaks following feedback
b730eaa 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux @yubiuser
Update docs/docker/build-image.md
21d24e2 
Co-authored-by: yubiuser <github@yubiuser.dev>
Signed-off-by: Adam Warner <github@adamwarner.co.uk>
@PromoFaux
Update local image name following pi-hole/docker-pi-hole#1628
43c5369 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
development-v6 -> development
5ef5a90
@PromoFaux
Add navigation.indexes feature
83ee25e 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Rename Pi-hole Core -> The pihole command, move it to main and …
627c8a2 
…add redirect.

Remove images that are not referenced anywhere else

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Database section. Rationalise section names to match titles and add r…
61d413f 
…edirects.

Replace references to renamed pages

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
API Section. Tidy up titles
323f51b 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
FTLDNS
de5b0a5 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Group management section, add redirect
120eff1 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
RegEx Blocking section. Title Case and redirects
6023ad3 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Guides section, add redirect links and update internal links
0ae479f 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Move the main overview page to the About Pi-hole level
f361b39 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Add index.md for Getting Started section
0432c94 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Contribution: Move contributing.md->index.md and move up one level
dbbdddb 
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@github-actions GitHub Actions
Copy link
Contributor

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

dependabot bot and others added 4 commits September 28, 2024 10:41
@dependabot
Bump actions/checkout in the github_action-dependencies group
1474dc8 
Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout).


Updates `actions/checkout` from 4.1.7 to 4.2.0
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.1.7...v4.2.0)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
Bump mkdocs-material from 9.5.36 to 9.5.38 in the pip-dependencies group
1c7d9c7 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.36 to 9.5.38
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.36...9.5.38)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
@yubiuser
Merge pull request #1104 from pi-hole/dependabot/github_actions/relea…
2231e14 
…se/v6.0/github_action-dependencies-aa3137d618

Bump actions/checkout from 4.1.7 to 4.2.0 in the github_action-dependencies group
@yubiuser
Merge pull request #1105 from pi-hole/dependabot/pip/release/v6.0/pip…
7d29f90 
…-dependencies-9dab37ee1f

Bump mkdocs-material from 9.5.36 to 9.5.38 in the pip-dependencies group
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

@NittanySeaLion NittanySeaLion NittanySeaLion requested changes

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

Assignees
No one assigned
Labels
Merge Conflict Never Stale
Projects
None yet
Milestone
v6.0
Development

Successfully merging this pull request may close these issues.
6 participants
@DL6ER @yubiuser @pralor-bot @NittanySeaLion @PromoFaux @dschaper