Skip to content

fix: Update link to docs about snap metadata #5618

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.

Sign up for GitHub

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

Merged
steverydz merged 1 commit into from
Mar 11, 2026
Merged

fix: Update link to docs about snap metadata #5618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions redirects.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ docs/defining-a-command/?: https://documentation.ubuntu.com/snapcraft/stable/tut
docs/snapcraft-docker-images/?: https://documentation.ubuntu.com/snapcraft/stable/how-to/crafting/specify-a-base/#containers
docs/snapcraft-tutorials/?: https://documentation.ubuntu.com/snapcraft/stable/tutorials/
docs/snapcraft-reference/?: https://documentation.ubuntu.com/snapcraft/stable/reference/
docs/snapcraft-top-level-metadata/?: https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml/
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

The frontend links use the URL without a trailing slash, but this redirect target includes one. If the docs site canonicalizes differently, this can add an extra redirect hop and may not match the QA expectation exactly. Consider aligning the redirect target with the URL used in the UI (or vice versa) for consistency.

Suggested change
docs/snapcraft-top-level-metadata/?: https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml/
docs/snapcraft-top-level-metadata/?: https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml

Copilot uses AI. Check for mistakes.

# Legacy forum redirects for pages that don't exist in RTD.
# These are temporary and will be replaced when Snapcraft 7 is migrated.
Expand Down
2 changes: 1 addition & 1 deletion static/js/publisher/pages/Listing/ListingForm/ListingForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ function ListingForm({ data, refetch }: Props): React.JSX.Element {
version of the snapcraft.yaml released to the stable channel.{" "}
<a
className="p-link--external"
href="/docs/snapcraft-top-level-metadata"
href="https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml"
>
Learn more
</a>
Expand Down
5 changes: 4 additions & 1 deletion static/js/publisher/pages/PublisherSettings/PublisherSettingsForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,10 @@ function PublisherSettingsForm({ settings }: Props) {
the latest revision pushed to the stable channel. If you
manually edit the Listing page, the automatic updates will
be turned off.{" "}
<a href="/docs/snapcraft-top-level-metadata">Learn more</a>.
<a href="https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml">
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

This link now points to an external documentation site, but it doesn’t use the external-link styling that’s used for the same destination in the ListingForm notification ("p-link--external"). Consider applying the same class here so users get consistent affordance when leaving snapcraft.io.

Suggested change
<a href="https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml">
<a
href="https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml"
className="p-link--external"
>

Copilot uses AI. Check for mistakes.
Learn more
</a>
.
Comment on lines +407 to +408
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

The period after the “Learn more” link is now rendered as a separate text node after the closing . In JSX this introduces whitespace/newline between the link and the period, which can display as “Learn more .”. Consider moving the period immediately adjacent to the closing tag or rendering it without leading whitespace (e.g., as its own JSX string).

Suggested change
</a>
.
</a>.

Copilot uses AI. Check for mistakes.
</span>
</label>
{getValues("update_metadata_on_release") && (
Expand Down
Loading
⚡