← Back to issue list

docs: Updating how to crafting pages to new linking method

View original Github issue

Metadata

Project
rockcraft
Number
#1068
Type
pull request
State
merged
Author
asanvaq
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update replacing outdated craft-parts links with the new linking method. Resolves #1067, corrects build override references, and was approved before merging despite one failing CI check.

Suggested action:

No scores available.

Issue body

This tackles #1067 and is related to #1066. How to override a build and how to include files are still linked to craft-parts using the old method. They should be linked following the example from snapcraft: https://github.com/canonical/snapcraft/blob/805444a60da3c16b9a5f3f84d2dfeede90c86fc3/docs/how-to/crafting/index.rst. This PR solves this. This will also make sure [Override the build](https://documentation.ubuntu.com/rockcraft/stable/common/craft-parts/how-to/override_build/) mentions the correct tool. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update replacing outdated craft-parts links with the new linking method. Resolves #1067, corrects build override references, and was approved before merging despite one failing CI check.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update aligning crafting pages with the new linking method. Updated outdated links for build overrides and file inclusion, corrected tool references, and matched snapcraft documentation.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update replacing outdated craft-parts links with the new linking method across crafting pages. Corrects override build tool references and resolves issue #1067.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1067 docs: How-to Crafting still links to craft-parts using the old method rockcraft closed Outdated craft-parts documentation links in crafting guides were updated to match current standards. The fix was merged in pull request #1068, resolving the issue.
82%
#1195 docs: remove Craft Parts links from docstrings craft-parts merged Merged after reviewer approval and passing CI. Removed Craft Parts links from docstrings, replacing them with internal references for proper versioning and resilience. A changelog entry was added per reviewer request.
78%
#398 docs: fix link to craft cli craft-store merged Merged a documentation fix updating a broken Craft CLI link after a path change. Approved by one reviewer, passed CI checks, and modified one file.
77%
#4679 refactor(docs): use more docs from craft-parts snapcraft merged Merged documentation refactor replacing duplicated content with direct references or includes from shared craft-parts docs. Approved by two reviewers, passed CI, modified 18 files, and maintained 100% test coverage on changed lines.
75%
#2186 docs: fix build errors charmcraft merged Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021.
74%
#314 docs: clean up references to Craft Parts rockcraft closed Superseded by PR #308. Documentation cleanup for Craft Parts references was incorporated into that pull request instead of merging here.
73%
#2070 docs: fix build errors in craft-parts charmcraft closed Merged to resolve documentation build errors in craft-parts. Changes fix ref and label issues, with some dependencies on an upstream PR. Integrated directly by the maintainer without reviewer comments or CI checks.
73%
#5480 docs: migrate 'using craftctl' snapcraft merged Merged documentation migration for 'using craftctl' and updated Craft Parts dependency to align with upstream docs. Approved by three reviewers and passed all CI checks across multiple platforms.
73%
#404 docs: add an explanation of parts craft-parts merged Merged documentation update explaining parts, adding 628 lines across nine files. Approved by one reviewer, references CRAFT-1612, and was finalized after initial feedback collection.
73%
#103 docs: update package documentation (CRAFT-37) craft-parts merged Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83).
73%