Clarify documentation according to feedback (infra)#1740
Merged
Conversation
Removed very outdated howto as it serves no purpose anymore
artiepoole
requested changes
Feb 27, 2025
artiepoole
left a comment
artiepoole
left a comment
There was a problem hiding this comment.
Some additional comments not related to these changes:
-
Typo spotted on the second note in Writing A Test Plan: test plans
antand test jobs in separate files -
In Creating a new provider on "Writing test jobs" page, the
2024is randomly bold and blue. This could be local settings but a similar thing happens throughout for theid:tags andcdcommands
pieqq
previously approved these changes
Feb 28, 2025
Collaborator
pieqq
left a comment
pieqq
left a comment
There was a problem hiding this comment.
Just a few suggestions, otherwise good to land! Thanks for updating the docs!
Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
pieqq
approved these changes
Feb 28, 2025
stanley31huang
pushed a commit
that referenced
this pull request
Mar 28, 2025
* Clarify manage validate, jq on base, builtin categories and mk-venv typo * Clarify how to work on ubuntu core further Removed very outdated howto as it serves no purpose anymore * Remember the user to disable the checkbox agent * Clarify mixed namespacing * Fixed weird styling, typos and clarified a few phrases * Apply suggestions from code review Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com> --------- Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
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
3 participants
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.
Description
There are quite a few aspects of the two new tutorials which were unclear as brought up by a recent hire. This clarifies them all, here is a list:
Resolved issues
Fixes: CHECKBOX-1741
Documentation
N/A
Tests
N/A