docs: add a "pack a Pro artifact" how-to - #1144
Open
mr-cal wants to merge 4 commits into
Open
Conversation
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
6 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new how-to guide describing how to pack a Pro-compliant artifact using Ubuntu Pro services, integrating it into the documentation navigation and release notes for Craft Application.
Changes:
- Adds a new how-to entry point page (
docs/how-to/pack-a-pro-artifact.rst) that includes shared/common content. - Introduces the shared how-to content under
docs/common/.../pack-a-pro-artifact.rstand wires it into Sphinx’s build configuration. - Updates the how-to toctree and changelog to surface the new guide.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/changelog.rst | Adds a changelog entry referencing the new how-to guide. |
| docs/how-to/pack-a-pro-artifact.rst | New how-to wrapper that defines substitutions and includes the shared content. |
| docs/how-to/index.rst | Adds the new how-to page to the how-to guides toctree. |
| docs/conf.py | Excludes the new shared/common how-to source from direct processing, consistent with other common docs. |
| docs/common/craft-application/how-to-guides/pack-a-pro-artifact.rst | Adds the shared how-to content describing Ubuntu Pro-enabled packing. |
mr-cal
force-pushed
the
work/CRAFT-5237/pro-docs
branch
3 times, most recently
from
July 22, 2026 16:49
5ad08ca to
9f34722
Compare
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
mr-cal
force-pushed
the
work/CRAFT-5237/pro-docs
branch
from
July 22, 2026 16:55
9f34722 to
b89d5ad
Compare
Contributor
Author
|
Test failures fixed in #1146 |
mr-cal
marked this pull request as ready for review
July 22, 2026 19:56
mr-cal
requested review from
medubelko and
steinbro
and removed request for
a team and
lengau
July 22, 2026 19:56
medubelko
requested changes
Jul 22, 2026
Comment on lines
+1
to
+2
| .. meta:: | ||
| :description: Pack |an-artifact| that contains extended security patches or meets regulatory compliance needs, powered by Ubuntu Pro. |
Contributor
There was a problem hiding this comment.
Required:
The advanced substitutions extension doesn't work for meta, unfortunately, so we'll need to move this into the destination page. It's better that way, since there will be many instances where we need to customise it.
| Follow this guide to pack |an-artifact| that contains extended security patches or meets | ||
| regulatory compliance needs. | ||
|
|
||
| .. Split point for downstream docs: Prerequisites onward |
Contributor
There was a problem hiding this comment.
There are a few places in other docs where we use:
Suggested change
| .. Split point for downstream docs: Prerequisites onward | |
| .. Begin prerequisites |
It's a little bit easier to cite in the include options.
Contributor
Author
There was a problem hiding this comment.
I followed this method but tweaked it slightly to accomodate the feedback in the downstream PR in snapcraft
| Documentation | ||
| ============= | ||
|
|
||
| - Add a :ref:`how-to-pack-a-pro-artifact` how-to document. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Add a :ref:`how-to-pack-a-pro-artifact` how-to document. | |
| - Add a :ref:`how-to-pack-a-pro-artifact` how-to guide. |
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
steinbro
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make lint && make test?docs/reference/changelog.rst)?Adds a pack a Pro artifact how-to document.
The first commit migrates the Rockcraft doc verbatim, the second commit makes it generic.
Used downstream in canonical/snapcraft#6367.
(CRAFT-5237)