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

Move wiki to readme #419

Merged
merged 1 commit into from
Feb 17, 2025
Merged

Conversation

mwoolweaver
Copy link
Contributor

Thank you for your contribution to the Pi-hole Community!

Please read the comments below to help us consider your Pull Request.

We are all volunteers and completing the process outlined will help us review your commits quicker.

Please make sure you

  1. Base your code and PRs against the repositories developmental branch.
  2. Sign Off all commits as we enforce the DCO for all contributions
  3. Sign all your commits as they must have verified signatures
  4. File a pull request for any change that requires changes to our documentation at our documentation repo

What does this PR aim to accomplish?:

Move info from Wiki to Readme. Should help with maintaining in the future. See #333

How does this PR accomplish the above?:

Link documentation PRs if any are needed to support this PR:


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)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.

  • [✓] I have read the above and my PR is ready for review. Check this box to confirm

@mwoolweaver mwoolweaver changed the base branch from master to development February 15, 2025 23:20
@mwoolweaver mwoolweaver mentioned this pull request Feb 15, 2025
@mwoolweaver
Copy link
Contributor Author

Should the Docker information be higher up?

@mwoolweaver
Copy link
Contributor Author

i will squash all these commits once it's all finished

@mwoolweaver
Copy link
Contributor Author

Also as a side note

I am unable to confirm if the PiTFT instructions actually work. The wiki page hasn't been updated since 2018 so there's a chance they aren't accurate.

@yubiuser
Copy link
Member

I am unable to confirm if the PiTFT instructions actually work. The wiki page hasn't been updated since 2018 so there's a chance they aren't accurate.

I'm not sure any of the developers uses such a PiTFT display. But this is something open source is good for - users can tell us if old guides don't work anymore

Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

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

I think the content is fine now. I only wonder if we should undo your last changes where you put the instructions for running it on a different machine below.

Personally, I would have a but section "Using PADD" with those subsection

  1. Running it on the Pi-hole device
  2. Running it on any device in your network
  3. Running it on docker
  4. PiTFT

Last: Update PADD

@mwoolweaver
Copy link
Contributor Author

I can make those adjustments and squash again

@mwoolweaver mwoolweaver force-pushed the move-wiki-to-readme branch 2 times, most recently from 853c059 to 969f5c8 Compare February 17, 2025 04:52
Co-authored-by: yubiuser <[email protected]>
Signed-off-by: Michael Woolweaver <[email protected]>
@yubiuser yubiuser merged commit 1f78753 into pi-hole:development Feb 17, 2025
3 checks passed
@mwoolweaver
Copy link
Contributor Author

maybe this should have waited for #416 considering the steps given?

@yubiuser
Copy link
Member

Upps... I don't mind. I'm sure at some point 416 will be merged :-) If not we can easily change the Readme again.

@mwoolweaver mwoolweaver deleted the move-wiki-to-readme branch February 18, 2025 03:54
@yubiuser yubiuser mentioned this pull request Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants