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

Pi-hole v6.0 documentation #338

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

Pi-hole v6.0 documentation #338

wants to merge 272 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

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 51543da
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/673312e4d0f9020008d81143
😎 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.

@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2023

Conflicts have been resolved.

@yubiuser
Copy link
Member

yubiuser commented Aug 4, 2023

@DL6ER

Do we really need all the stuff in /docs/MathJax-es5 added by 6420a58

I think this is used only in one place: https://deploy-preview-338--pihole-docs.netlify.app/api/auth/#description-of-the-algorithm

P.S. where is the location of e.g. /docs/api/auth?

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Conflicts have been resolved.

@DL6ER
Copy link
Member Author

DL6ER commented Aug 4, 2023

This branch is heavily outdated. It was started a long time ago when we still thought we need to document everything by hand. Now that we have the OpenAPI specs and the automatically generated documentation out of it, it may be time to rethink (and possibly redo) this entire branch.

Signed-off-by: Christian König <[email protected]>
@yubiuser
Copy link
Member

yubiuser commented Aug 7, 2023

Mhh.. this is strange... despite not touching it, all the API documentation is gone... Even the link I posted 3 days ago does not work anymore.

dependabot bot and others added 6 commits September 3, 2023 20:55
Bumps [actions/checkout](https://github.com/actions/checkout) from 3.5.3 to 3.6.0.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3.5.3...v3.6.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [linkinator](https://github.com/JustinBeckwith/linkinator) from 5.0.1 to 5.0.2.
- [Release notes](https://github.com/JustinBeckwith/linkinator/releases)
- [Commits](JustinBeckwith/linkinator@v5.0.1...v5.0.2)

---
updated-dependencies:
- dependency-name: linkinator
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.7.0 to 3.8.1.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v3.7.0...v3.8.1)

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

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.1.21 to 9.2.7.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.1.21...9.2.7)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [mkdocs](https://github.com/mkdocs/mkdocs) from 1.5.1 to 1.5.2.
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.5.1...1.5.2)

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

Signed-off-by: dependabot[bot] <[email protected]>
…e/v6.0/actions/checkout-3.6.0

Bump actions/checkout from 3.5.3 to 3.6.0
PromoFaux and others added 19 commits October 2, 2024 19:29
…t configuration and upgrading (with dedicated section about upgrading from V5)

Signed-off-by: Adam Warner <[email protected]>
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.38 to 9.5.39
- [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.38...9.5.39)

---
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] <[email protected]>
…-dependencies-5d708111c2

Bump mkdocs-material from 9.5.38 to 9.5.39 in the pip-dependencies group
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.39 to 9.5.40
- [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.39...9.5.40)

---
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] <[email protected]>
Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout).


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

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

Signed-off-by: dependabot[bot] <[email protected]>
Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator).


Updates `linkinator` from 6.1.1 to 6.1.2
- [Release notes](https://github.com/JustinBeckwith/linkinator/releases)
- [Commits](JustinBeckwith/linkinator@v6.1.1...v6.1.2)

---
updated-dependencies:
- dependency-name: linkinator
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
…-dependencies-2fa875aea2

Bump mkdocs-material from 9.5.39 to 9.5.40 in the pip-dependencies group
…se/v6.0/github_action-dependencies-a9bb80ae19

Bump actions/checkout from 4.2.0 to 4.2.1 in the github_action-dependencies group
…/v6.0/npm-dependencies-d83d990322

Bump linkinator from 6.1.1 to 6.1.2 in the npm-dependencies group
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.40 to 9.5.41
- [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.40...9.5.41)

---
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] <[email protected]>
…-dependencies-d5cb191d72

Bump mkdocs-material from 9.5.40 to 9.5.41 in the pip-dependencies group
Bumps the github_action-dependencies group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [actions/setup-python](https://github.com/actions/setup-python) and [actions/setup-node](https://github.com/actions/setup-node).


Updates `actions/checkout` from 4.2.1 to 4.2.2
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.2.1...v4.2.2)

Updates `actions/setup-python` from 5.2.0 to 5.3.0
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5.2.0...v5.3.0)

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

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

Signed-off-by: dependabot[bot] <[email protected]>
Bumps the pip-dependencies group with 2 updates: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.9 to 1.3.0
- [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases)
- [Commits](timvink/mkdocs-git-revision-date-localized-plugin@v1.2.9...v1.3.0)

Updates `mkdocs-material` from 9.5.41 to 9.5.42
- [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.41...9.5.42)

---
updated-dependencies:
- dependency-name: mkdocs-git-revision-date-localized-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: pip-dependencies
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
…se/v6.0/github_action-dependencies-042d55de69

Bump the github_action-dependencies group with 3 updates
…-dependencies-51ab7d45ad

Bump the pip-dependencies group with 2 updates
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.42 to 9.5.43
- [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.42...9.5.43)

---
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] <[email protected]>
…-dependencies-0610082a93

Bump mkdocs-material from 9.5.42 to 9.5.43 in the pip-dependencies group
Copy link
Contributor

github-actions bot commented Nov 9, 2024

Conflicts have been resolved.

DL6ER and others added 3 commits November 9, 2024 08:49
Bumps the pip-dependencies group with 2 updates: [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocs-redirects](https://github.com/mkdocs/mkdocs-redirects).


Updates `mkdocs-material` from 9.5.43 to 9.5.44
- [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.43...9.5.44)

Updates `mkdocs-redirects` from 1.2.1 to 1.2.2
- [Release notes](https://github.com/mkdocs/mkdocs-redirects/releases)
- [Commits](mkdocs/mkdocs-redirects@v1.2.1...v1.2.2)

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

Signed-off-by: dependabot[bot] <[email protected]>
…-dependencies-9f7f3b73eb

Bump the pip-dependencies group with 2 updates
docs/ftldns/debugging.md Outdated Show resolved Hide resolved
yubiuser and others added 5 commits November 9, 2024 17:27
Co-authored-by: RD WebDesign <[email protected]>
Signed-off-by: yubiuser <[email protected]>
…ak on real-time signals. We add more signals than we actually use as the start of the real-time signals (the value of SIGRTMIN) varies between systems. Typically, they start at 32 on Linux, however, POSIX threads (which we are using) may shift RTMIN to 34 (NPTL) or 35 (LinuxThreads) instead, see man signal(7) for further details

Signed-off-by: DL6ER <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants