Skip to content

Revamp the PPA reference guide to Diataxis standards#511

Open
lgp171188 wants to merge 12 commits into
canonical:mainfrom
lgp171188:revamp-user-docs-ppa-reference
Open

Revamp the PPA reference guide to Diataxis standards#511
lgp171188 wants to merge 12 commits into
canonical:mainfrom
lgp171188:revamp-user-docs-ppa-reference

Conversation

@lgp171188

Copy link
Copy Markdown
Collaborator

Move some of the existing content to other relevant places

  • I ran make linkcheck-discrete locally to confirm new or edited links
    will pass the linkcheck CI.

@lgp171188 lgp171188 requested a review from odadacharles May 20, 2026 07:03
Move some of the existing content to other relevant places
@lgp171188 lgp171188 force-pushed the revamp-user-docs-ppa-reference branch from 9346adb to e7691c6 Compare May 20, 2026 07:09
@jugmac00

Copy link
Copy Markdown
Member

What do you think about grouping the PPA related how-tos similar to the ones in the explanation section?

@lgp171188

Copy link
Copy Markdown
Collaborator Author

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.

@jugmac00

Copy link
Copy Markdown
Member

We did not look into any how-to guides at all.

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

Packaging
- PPA
-- PPA topic 1
-- PPA topic 2
- Snaps
- Rocks
- ...

@lgp171188

Copy link
Copy Markdown
Collaborator Author

We did not look into any how-to guides at all.
That is confusing.. as a lot of how-tos are updated/created with this PR.

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 odadacharles left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

Comment on lines +15 to +16
provisioned for that build alone. Each build starts in a clean chroot
and is torn down on completion. This guarantees two properties:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

Comment thread docs/user/explanation/packaging/ppa-build-environment.rst Outdated
Comment thread docs/user/explanation/packaging/ppa-overview.rst Outdated
Comment thread docs/user/explanation/packaging/ppa-overview.rst Outdated
Comment thread docs/user/explanation/packaging/ppa-vs-ubuntu-archive.rst Outdated
Comment thread docs/user/how-to/packaging/request-ppa-architectures.rst Outdated
Comment thread docs/user/how-to/packaging/request-ppa-architectures.rst Outdated
Comment thread docs/user/reference/packaging/ppas/ppa.rst Outdated
Comment thread docs/user/reference/packaging/ppas/ppa.rst Outdated
Comment on lines +109 to +116
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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This information should be in the other doc on creating PPAs which already captures some of this.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

There is still some value in this being in the reference guide which talks about all other aspects of a PPA, no?

lgp171188 and others added 11 commits May 29, 2026 10:49
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>
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.

3 participants