Skip to content

[Feature-8023][Document] Add example and notice about task type Python#713

Merged
zhongjiajie merged 1 commit intoapache:masterfrom
EricGao888:Fix-8023
Apr 1, 2022
Merged

[Feature-8023][Document] Add example and notice about task type Python#713
zhongjiajie merged 1 commit intoapache:masterfrom
EricGao888:Fix-8023

Conversation

@EricGao888
Copy link
Copy Markdown
Member

@EricGao888 EricGao888 commented Mar 4, 2022

@EricGao888
Copy link
Copy Markdown
Member Author

  • Based on the shell task example, this pr adds example and notice about task type Python
  • This pr closes: #8023

@zhongjiajie FYi, this pr is WIP. I only fix the python task examples in English dev version in this commit. If things look good, I will fix python task examples in other versions of docs in the following commits. Thx : )

@zhongjiajie
Copy link
Copy Markdown
Member

will task a look tomorrow, is midnight now

@zhongjiajie zhongjiajie added task waiting for review Waiting review from reviewer labels Mar 5, 2022
Copy link
Copy Markdown
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.

Looking good! thanks @EricGao888. FYI you just need to change dev and latest(for now is2.0.3) doc in both EN and ZH doc. we could jus ignore previous verisons

@zhongjiajie zhongjiajie added waiting user response Waiting PR submiter response and removed waiting for review Waiting review from reviewer labels Mar 5, 2022
@EricGao888
Copy link
Copy Markdown
Member Author

EricGao888 commented Mar 7, 2022

Looking good! thanks @EricGao888. FYI you just need to change dev and latest(for now is2.0.3) doc in both EN and ZH doc. we could jus ignore previous verisons

Sure, thx for the comment! BTW maybe we can adopt jinjava or other template lib to generate doc in the feture? I think that may save a lot of work.

@zhongjiajie
Copy link
Copy Markdown
Member

Good point, yeah, we already have a plan in apache/dolphinscheduler#6535, section DRY. But our community do not have time to do it

@zhongjiajie
Copy link
Copy Markdown
Member

BTW, we plan to move our docs into main repo. After that we only need to change dev version docs. (in most cases)

@EricGao888
Copy link
Copy Markdown
Member Author

Looking good! thanks @EricGao888. FYI you just need to change dev and latest(for now is2.0.3) doc in both EN and ZH doc. we could jus ignore previous verisons

@zhongjiajie I've changed the dev and latest(2.0.5) doc in both EN and ZH versions. PTAL

Copy link
Copy Markdown
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.

docs looking good, but could you change the screenshot to latest in branch dev? We change our UI recently which you can see https://dolphinscheduler.apache.org/en-us/docs/dev/user_doc/guide/task/flink.html as example

@EricGao888
Copy link
Copy Markdown
Member Author

docs looking good, but could you change the screenshot to latest in branch dev? We change our UI recently which you can see https://dolphinscheduler.apache.org/en-us/docs/dev/user_doc/guide/task/flink.html as example

Sure, the new UI looks cool!

@EricGao888
Copy link
Copy Markdown
Member Author

docs looking good, but could you change the screenshot to latest in branch dev? We change our UI recently which you can see https://dolphinscheduler.apache.org/en-us/docs/dev/user_doc/guide/task/flink.html as example

Have changed the screenshots in dev directory to match the newest UI : )

@zhongjiajie
Copy link
Copy Markdown
Member

I approved the CI running just now

zhongjiajie
zhongjiajie previously approved these changes Mar 31, 2022
Copy link
Copy Markdown
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, thanks

Comment on lines -11 to -15
- Script: Python program developed by the user.
- Environment Name: Specific Python interpreter path for running the script. If you need to use Python **virtualenv**, you should create multiply environments for each **virtualenv**.
- Resources: Refers to the list of resource files that need to be called in the script.
- User-defined parameter: It is a user-defined local parameter of Python, and will replace the content with `${variable}` in the script.
- Note: If you import the python file under the resource directory tree, you need to add the `__init__.py` file.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

BTW, @Tianqi-Dotes could you make a double check about our dev EN document change?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I find that we have some docs overwrite in other PR

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@zhongjiajie @Tianqi-Dotes Is there anything else I could do here? I mean the docs overwrite stuff, not sure what it is.

@zhongjiajie zhongjiajie added don't merge Do not merge this PR for some reason waiting for review Waiting review from reviewer and removed waiting user response Waiting PR submiter response labels Mar 31, 2022
Copy link
Copy Markdown
Member

@Tianqi-Dotes Tianqi-Dotes left a comment

Choose a reason for hiding this comment

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

Hi Mr. Gao,
please try not to use passive patterns in technology writing. Thanks for the contribution.
Yours

@zhongjiajie
Copy link
Copy Markdown
Member

Thanks @Tianqi-Dotes for reviewing

@EricGao888
Copy link
Copy Markdown
Member Author

Hi Mr. Gao, please try not to use passive patterns in technology writing. Thanks for the contribution. Yours

@Tianqi-Dotes Hi Tianqi, thx for helping me review the docs in such detail. I've fixed the related language issues and resolved the comments : )

@EricGao888 EricGao888 requested a review from zhongjiajie April 1, 2022 11:32
@zhongjiajie
Copy link
Copy Markdown
Member

I will merge it when it finishes the CI, and then will do the doc migration

@EricGao888
Copy link
Copy Markdown
Member Author

I will merge it when it finishes the CI, and then will do the doc migration

@zhongjiajie Cool, I'm looking forward to the doc migration. After migration, it seems easier for developers to contribute to dolphin docs and I'd like to keep contributing to these docs : )

@zhongjiajie zhongjiajie removed the waiting for review Waiting review from reviewer label Apr 1, 2022
Copy link
Copy Markdown
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, thanks and I will migrate it ASAP

@zhongjiajie zhongjiajie merged commit 4b5c6a2 into apache:master Apr 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

don't merge Do not merge this PR for some reason task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature][Document] Add example and notice about task type Python

3 participants