Info for serving poudriere packages privately #66
Conversation
This adds a small section to the "Configuring pkg Clients to Use a Poudriere Repository" showing the user how to point to their packages repository (package directory in this case) via `file://`. Allowing the user to not have to publicly expose their packages over the internet.
|
LGTM |
|
In order to credit you properly with |
|
@debdrup Thank you. That's correct :). |
There was a problem hiding this comment.
Alright, I've had a little time to review it now, and I've found a couple of things.
Firstly, we have some writing style guidelines that I think need to be applied to this - specifically, I think this paragraph uses a lot of informal speech by addressing the reader directly.
Secondly, I think it needs to be broken into multiple sentences and have the parenthesis moved - it's a bit too run-on as it is, and the parenthesis feels more like a conditional clause that could be worded better.
Overall, I think it's a good change though - so if you can run over the FDP (not just the section I linked to), adjust as necessary, and keep in mind the other thing, I think we can get this landed in short order. :)
|
@debdrup Thanks for the feedback :). I'll take a look at the guidelines and push another change. |
|
@debdrup I finally got a chance to take a look at the FreeBSD guidelines and philosophy for writing. After looking at it, I've realized that my personal philosophy for technical writing is very different (and I highly prefer writing informally since I like to feel (and want the reader to feel) closer). Ultimately it just isn't fun nor enjoyable for me writing otherwise. There's many other things as well but those are the main ones. For this reason I've decided to close this PR. If someone really wants to include this change then I encourage them to take what I wrote and convert it to the FreeBSD style appropriately. Thanks for taking the time to take a look at my PR and give me feedback. I felt it was necessary to at least give a reason as to why I would not continue rather than just silently closing it. Take care! |
|
@debdrup Hey, since recently I got a chance to spend a lot more time in the docs (mostly reading), I re-read most of the FDP again and decided to take another crack at this. I checked out a copy of the docs locally and decided to open the following PR: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263955 We can continue further discussion on there since this branch is stale anyways and I generated a diff for submission via the problem report interface instead. I'll be using this experience as an opportunity to further improve my "formal technical writing" as oppose to my "informal technical writing" :D. |
FreeBSD Handbook: …: Configuring pkg Clients to Use a Poudriere Repository Add a small section showing the user how to point to their packages repository (package directory in this case) via file://. Allow the user to not publicly expose their packages over the Internet. https://bugs.freebsd.org/263955 PR: 263955 Reported by: Jonathan Vasquez Reviewed by: debdrup, pauamma Pull request: #66
This adds a small section to the "Configuring pkg Clients to Use a Poudriere Repository" showing the user how to point to their packages repository (package directory in this case) via
file://. Allowing the user to not have to publicly expose their packages over the internet.