← Back to issue list

docs: update tutorial terminal blocks with correct metadata

View original Github issue

Metadata

Project
charmcraft
Number
#2700
Type
pull request
State
merged
Author
danielvnguyen
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update standardizing terminal block metadata across tutorial guides. Approved by three reviewers, passed CI, and resolves Jira ticket ISD-5216. Modified six files with 65 line additions.

Suggested action:

No scores available.

Issue body

This PR standardizes the terminal block metadata (user, host, and directory) across the tutorial documentation to provide a clear, step-by-step path for the user. Resolves Jira ticket: [ISD-5216](https://warthogs.atlassian.net/browse/ISD-5216) --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [x] I've updated the relevant release notes. *(N/A - doc formatting only)*. [ISD-5216]: https://warthogs.atlassian.net/browse/ISD-5216?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update standardizing terminal block metadata across tutorial guides. Approved by three reviewers, passed CI, and resolves Jira ticket ISD-5216. Modified six files with 65 line additions.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update standardizing terminal block metadata across the tutorial. Resolves Jira ticket ISD-5216 by ensuring consistent user, host, and directory information for clearer step-by-step guidance.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1209 docs: update tutorial terminal blocks with correct metadata rockcraft merged Merged after three reviewers approved and all CI checks passed. The update standardizes terminal block metadata in tutorial docs, resolving Jira ticket ISD-5216. A maintainer completed the merge after the author requested access.
96%
#19 docs: update toc and incorrect labels craft-store merged Merged documentation update correcting the table of contents and fixing incorrect labels across two files. Approved by a reviewer and passing CI, the +4/-1 line changes were integrated into the main branch.
71%
#5929 docs: adjust wording and terminal text in tutorial snapcraft merged Merged documentation update adjusting tutorial wording and terminal text. Added a guardrail to prevent accidental copying of grade and confinement keys. Approved by two reviewers and passed CI checks before integration.
71%
#1079 docs: fix terminal directive craft-application merged Merged a one-line documentation fix correcting the terminal directive rendering for multiline input. Approved by one reviewer with all CI checks passing.
71%
#144 docs: update meta description guidelines starflow merged Merged documentation update applying the latest meta description guidelines and examples. Approved by one reviewer with all CI checks passing. Changes span three files, adding 43 lines and removing 47.
71%
#2810 docs: fix terminal directives charmcraft merged Merged documentation updates fixing terminal directive rendering. Approved by one reviewer and passing all CI checks, the changes serve as a temporary fix until CHARMCRAFT-684 is implemented, modifying 11 files.
70%