Skip to content

[Improvement] [Doc] Put default task parameters in a new file#11776

Merged
zhongjiajie merged 3 commits intoapache:devfrom
EricGao888:Fix-11687
Sep 15, 2022
Merged

[Improvement] [Doc] Put default task parameters in a new file#11776
zhongjiajie merged 3 commits intoapache:devfrom
EricGao888:Fix-11687

Conversation

@EricGao888
Copy link
Member

@EricGao888 EricGao888 commented Sep 5, 2022 •
edited
Loading

Purpose of the pull request

Brief change log

  • Already described above.

Verify this pull request

This pull request is docs cleanup without any test coverage.

@EricGao888 EricGao888 self-assigned this Sep 5, 2022
@EricGao888 EricGao888 added improvement make more easy to user or prompt friendly document labels Sep 5, 2022
@EricGao888 EricGao888 added this to the 3.0.1 milestone Sep 5, 2022
@EricGao888 EricGao888 marked this pull request as ready for review September 14, 2022 15:51
@EricGao888 EricGao888 requested a review from SbloodyS September 14, 2022 15:52
zhongjiajie
zhongjiajie approved these changes Sep 15, 2022
View reviewed changes
Copy link
Member

@zhongjiajie zhongjiajie left a comment

Choose a reason for hiding this comment

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

LGTM overall, and this may be the best way we can do it currently, but if we migrate our doc template to docusaurus, we can using .mdx file to show general parameter into each task docs instead of hyper link, you can see some example in https://stackoverflow.com/a/70702778/7152658 (I can not find in docusaurus official website, So I use SO link here)

@zhongjiajie
Copy link
Member

zhongjiajie commented Sep 15, 2022

Does @SbloodyS have other idea?

@SbloodyS
Copy link
Member

SbloodyS commented Sep 15, 2022

Does @SbloodyS have other idea?

Nope. That's great.

@zhongjiajie zhongjiajie merged commit a88cb02 into apache:dev Sep 15, 2022
@zhongjiajie
Copy link
Member

zhongjiajie commented Sep 15, 2022

@caishunfeng This PR also needs to cherry pick to 3.1.0, thanks

@caishunfeng
Copy link
Contributor

caishunfeng commented Sep 15, 2022

@caishunfeng This PR also needs to cherry pick to 3.1.0, thanks

OK, and this is the improvement, should this pr cherry-pick to 3.0.1? @zhongjiajie @EricGao888

caishunfeng pushed a commit to caishunfeng/dolphinscheduler that referenced this pull request Sep 15, 2022
@EricGao888 @caishunfeng
[Cherry-pick][Improvement] [Doc] Put default task parameters in a new…
ad4ee65 
… file apache#11776
@caishunfeng caishunfeng mentioned this pull request Sep 15, 2022
Merged
@caishunfeng caishunfeng modified the milestones: 3.0.1, 3.1.0 Sep 15, 2022
caishunfeng added a commit that referenced this pull request Sep 15, 2022
@caishunfeng @EricGao888
[Cherry-pick][Improvement] [Doc] Put default task parameters in a new…
0647b3e 
… file #11776 (#11957)

Co-authored-by: Eric Gao <ericgao.apache@gmail.com>
@zhongjiajie
Copy link
Member

zhongjiajie commented Sep 15, 2022

@caishunfeng This PR also needs to cherry pick to 3.1.0, thanks

OK, and this is the improvement, should this pr cherry-pick to 3.0.1? @zhongjiajie @EricGao888

maybe only 3.1.0, cherry-pick to 3.0.1 may cause many conflict

@EricGao888
Copy link
Member Author

EricGao888 commented Sep 15, 2022

@caishunfeng This PR also needs to cherry pick to 3.1.0, thanks

OK, and this is the improvement, should this pr cherry-pick to 3.0.1? @zhongjiajie @EricGao888

maybe only 3.1.0, cherry-pick to 3.0.1 may cause many conflict

+1，this PR is for better maintainability, it is unnecessary to pick it into 3.0.1.

xdu-chenrj pushed a commit to xdu-chenrj/dolphinscheduler that referenced this pull request Sep 17, 2022
@EricGao888 @xdu-chenrj
[improve][Doc] Put default task parameters in a new file (apache#11776)
30e8d8b 
* Put default task parameters in a new file
* Add links to task plugin default parameters appendix docs
* Update Chinese docs
@caishunfeng caishunfeng added the release cherry-pick Mark this issue/PR had cherry-pick for release version label Sep 19, 2022
@EricGao888 EricGao888 mentioned this pull request Sep 29, 2022
Merged
4 tasks
xdu-chenrj pushed a commit to xdu-chenrj/dolphinscheduler that referenced this pull request Oct 13, 2022
@EricGao888 @xdu-chenrj
[improve][Doc] Put default task parameters in a new file (apache#11776)
3850e3f 
* Put default task parameters in a new file
* Add links to task plugin default parameters appendix docs
* Update Chinese docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zhongjiajie zhongjiajie zhongjiajie approved these changes

@Tianqi-Dotes Tianqi-Dotes Awaiting requested review from Tianqi-Dotes

@SbloodyS SbloodyS Awaiting requested review from SbloodyS SbloodyS is a code owner

Assignees

@EricGao888 EricGao888

Labels

document improvement make more easy to user or prompt friendly release cherry-pick Mark this issue/PR had cherry-pick for release version

Projects

None yet

Milestone

3.1.0

Development

Successfully merging this pull request may close these issues.

[Doc][Task Plugin] Put default task parameters in a new file

4 participants

@EricGao888 @zhongjiajie @SbloodyS @caishunfeng