Revamp the PPA reference guide to Diataxis standards#511
Conversation
Move some of the existing content to other relevant places
9346adb to
e7691c6
Compare
|
What do you think about grouping the PPA related how-tos similar to the ones in the explanation section? |
I do not fully understand what you are referring to here - can you explain? This was work done to address issues surfaced during an earlier daily documentation time session that I participated and we looked into the PPA reference documentation and found issues to fix in it. We did not look into any how-to guides at all. While some new how-to guides have been created in this MP, it was only to preserve the information in the existing (old) page without having it all be incorrectly present in a reference guide. Any bigger picture discussion outside of just this specific document should be had a team-level so that everyone is aware and can participate/contribute. |
That is confusing.. as a lot of how-tos are updated/created with this PR. The PPA related how-tos are currently mixed with other how-tos for e.g. Snap building, see https://canonical-ubuntu-documentation-library--511.com.readthedocs.build/launchpad/user/how-to/packaging/ I would suggest a structure like... |
Let me clarify - I have just taken the contents of the existing PPA reference guide, revamped it to contain only the reference-style information. But since that involved removing a lot of potentially-useful content not present anywhere else in this documentation, I have repurposed them as a few new explanation and how-to guides. The original plan was to do these in 2 separate PRs - one that only revamped the existing reference page and the other to reintroduce the removed content. But thanks to my agentic co-workers who were too eager to please me, this was all done together. For the question of merging the PPA related documentation into a smaller number of pages - yes, that is a good idea. But it is increasing the scope of this PR out of context and so I propose having a follow-up discussion and a PR for that. |
odadacharles
left a comment
There was a problem hiding this comment.
Left quite a few comments. We should try to limit the number of individual docs by merging into existing docs, or merging new docs that are related, e.g., the creation and deletion of a PPA.
| provisioned for that build alone. Each build starts in a clean chroot | ||
| and is torn down on completion. This guarantees two properties: |
There was a problem hiding this comment.
What's being torn down in this instance? This makes it sound like it's the build that's torn down instead of the chroot.
| Signing key | ||
| ----------- | ||
|
|
||
| Launchpad generates a unique GPG key for each owner's default PPA and | ||
| reuses it for every PPA owned by the same user or team. The key and | ||
| the command required to trust it are shown on the PPA's overview page. | ||
| Key generation happens after the first upload and may take a few hours | ||
| to propagate to the keyservers. |
There was a problem hiding this comment.
This information should be in the other doc on creating PPAs which already captures some of this.
There was a problem hiding this comment.
There is still some value in this being in the reference guide which talks about all other aspects of a PPA, no?
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Co-authored-by: odadacharles <charles.odada@canonical.com>
Move some of the existing content to other relevant places
make linkcheck-discretelocally to confirm new or edited linkswill pass the linkcheck CI.