Repository navigation
[Doc-18680] Fix Shell task documentation inconsistencies - #18681
Merged
Merged
Conversation
chovy-3012
requested review from
Gallardot,
SbloodyS and
caishunfeng
as code owners
October 9, 2026 04:42
SbloodyS
requested changes
Oct 9, 2026
SbloodyS
left a comment
SbloodyS
left a comment
Member
There was a problem hiding this comment.
These two issues are of different types. Please split them into two issue and PR and submit them separately.
chovy-3012
force-pushed
the
Improvement-18680
branch
from
October 9, 2026 07:34
5f3560e to
1de876a
Compare
chovy-3012
changed the title
Contributor
Author
|
Thanks for the review @SbloodyS. I've split the PR as requested.
|
SbloodyS
reviewed
Oct 9, 2026
SbloodyS
left a comment
SbloodyS
left a comment
Member
There was a problem hiding this comment.
Do not document execution caching as a current task option
The added “Cache Execution” row describes configurable result reuse based on task definition, version, and parameters. However, the current Shell task form has no cache-execution setting, and TaskDefinition has no corresponding field.
The Chinese appendix already contains this stale description; copying it into English spreads the inconsistency rather than correcting it.
Please remove this row from both language versions.
- Fix grammar errors in en/shell.md (redundant 'shell type', misplaced img tag, 'whether is' -> 'whether it is', 'will be use' -> 'will be used') - Add parameter table (Script, User-defined parameter) to zh/shell.md, remove '此任务没有其他参数' - Add deprecated fields note to both zh/shell.md and en/shell.md - Add missing 'Group Priority' row to en/appendix.md - Remove stale 'Cache Execution' row from both en/appendix.md and zh/appendix.md - Apply spotless formatting to zh/shell.md
Contributor
Author
|
Thanks @SbloodyS for the review. I've made the following changes:
The PR now contains 4 files:
|
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
2 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.
Was this PR generated or assisted by AI?
NO.
Purpose of the pull request
Fix Shell task documentation inconsistencies between Chinese and English versions, grammar errors, missing appendix rows, and undocumented deprecated fields.
Brief change log
docs/docs/zh/guide/task/shell.md: Add missing parameter table; add note for deprecatedResourceInfo.idandresfieldsdocs/docs/en/guide/task/shell.md: Fix 4 grammar errors; add note for deprecated fieldsdocs/docs/en/guide/task/appendix.md: Add missingCache ExecutionandGroup PriorityrowsVerify this pull request
This pull request is code cleanup without any test coverage.