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

Open
wants to merge 324 commits into
base: master
Choose a base branch
from
Open

Pi-hole v6.0 documentation #338

wants to merge 324 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 214ef0e
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/6795e7e48ae3cf00087be00c
😎 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.

@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.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2023

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

@github-actions
Copy link
Contributor

Conflicts have been resolved.

@pralor-bot
Copy link
Collaborator

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/trouble-building-ftl-v6/65091/8

@pralor-bot
Copy link
Collaborator

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/documentation-install-v6-from-source/65591/2

Copy link

@NittanySeaLion NittanySeaLion left a comment

Choose a reason for hiding this comment

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

I couldn't figure out how to push a commit proposing these changes to this PR, but here are the changes I'd propose

docs/ftldns/compile.md Outdated Show resolved Hide resolved
docs/ftldns/compile.md Outdated Show resolved Hide resolved
docs/ftldns/compile.md Show resolved Hide resolved
dependabot bot and others added 2 commits October 28, 2023 10:49
Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator).

- [Release notes](https://github.com/JustinBeckwith/linkinator/releases)
- [Commits](JustinBeckwith/linkinator@v5.0.2...v6.0.0)

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

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

Bump the github_action-dependencies group with 1 update
DL6ER and others added 7 commits December 16, 2024 09:55
Add Home Assistant interaction example
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.48 to 9.5.49
- [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.48...9.5.49)

---
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-c52ef7e6a7

Bump mkdocs-material from 9.5.48 to 9.5.49 in the pip-dependencies group
Update docs to remove/replace outdated references
@DL6ER DL6ER marked this pull request as ready for review December 23, 2024 09:08
DL6ER and others added 3 commits December 23, 2024 10:08
Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2).


Updates `markdownlint-cli2` from 0.16.0 to 0.17.0
- [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md)
- [Commits](DavidAnson/markdownlint-cli2@v0.16.0...v0.17.0)

---
updated-dependencies:
- dependency-name: markdownlint-cli2
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
…/v6.0/npm-dependencies-3b0e5ae972

Bump markdownlint-cli2 from 0.16.0 to 0.17.0 in the npm-dependencies group
Copy link
Contributor

github-actions bot commented Jan 4, 2025

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

dependabot bot and others added 2 commits January 4, 2025 10:19
Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2).


Updates `markdownlint-cli2` from 0.17.0 to 0.17.1
- [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md)
- [Commits](DavidAnson/markdownlint-cli2@v0.17.0...v0.17.1)

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

Signed-off-by: dependabot[bot] <[email protected]>
…/v6.0/npm-dependencies-c781d5456a

Bump markdownlint-cli2 from 0.17.0 to 0.17.1 in the npm-dependencies group
Copy link
Contributor

github-actions bot commented Jan 4, 2025

Conflicts have been resolved.

dependabot bot and others added 4 commits January 11, 2025 10:36
Bumps the github_action-dependencies group with 1 update: [eps1lon/actions-label-merge-conflict](https://github.com/eps1lon/actions-label-merge-conflict).


Updates `eps1lon/actions-label-merge-conflict` from 3.0.2 to 3.0.3
- [Release notes](https://github.com/eps1lon/actions-label-merge-conflict/releases)
- [Changelog](https://github.com/eps1lon/actions-label-merge-conflict/blob/main/CHANGELOG.md)
- [Commits](eps1lon/actions-label-merge-conflict@v3.0.2...v3.0.3)

---
updated-dependencies:
- dependency-name: eps1lon/actions-label-merge-conflict
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

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

Bump eps1lon/actions-label-merge-conflict from 3.0.2 to 3.0.3 in the github_action-dependencies group
Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2).


Updates `markdownlint-cli2` from 0.17.1 to 0.17.2
- [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md)
- [Commits](DavidAnson/markdownlint-cli2@v0.17.1...v0.17.2)

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

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


Updates `mkdocs-material` from 9.5.49 to 9.5.50
- [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.49...9.5.50)

---
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]>
Copy link
Contributor

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

…/v6.0/npm-dependencies-ea46a08d23

Bump markdownlint-cli2 from 0.17.1 to 0.17.2 in the npm-dependencies group
Copy link
Contributor

Conflicts have been resolved.

yubiuser and others added 3 commits January 18, 2025 12:09
…-dependencies-2f8f3f13ab

Bump mkdocs-material from 9.5.49 to 9.5.50 in the pip-dependencies group
Bumps the github_action-dependencies group with 1 update: [actions/stale](https://github.com/actions/stale).


Updates `actions/stale` from 9.0.0 to 9.1.0
- [Release notes](https://github.com/actions/stale/releases)
- [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md)
- [Commits](actions/stale@v9.0.0...v9.1.0)

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

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

Bump actions/stale from 9.0.0 to 9.1.0 in the github_action-dependencies group
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