Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Add HowTo on writing workflows #4112

Merged
merged 4 commits into from
May 29, 2020
Merged

Docs: Add HowTo on writing workflows #4112

merged 4 commits into from
May 29, 2020

Conversation

mbercx
Copy link
Member

@mbercx mbercx commented May 25, 2020

Fixes #3991 .

@mbercx
Copy link
Member Author

mbercx commented May 25, 2020

First draft of the how-to on writing workflows. I have kept the how-to rather succinct right now, let me know if there are topics that you think are missing. Examples of topics that aren't discussed right now:

  • Exit codes for work functions
  • Exposing inputs
  • More complex work chain logic (if_, while)

One thing I just realized I forgot to mention is that the daemon needs to be able to find the work chain. I'll be sure to do that in the first round of corrections.

The structure of the work chain how-to is to start by showing the example MultiplyAddWorkChain and then going over the methods one by one. Let me know if you think another structure is preferable.

@mbercx mbercx requested a review from sphuber May 25, 2020 13:28
@csadorf csadorf linked an issue May 25, 2020 that may be closed by this pull request
Docs: How to write workflows #3991
Closed
@csadorf
Copy link
Contributor

csadorf commented May 28, 2020

@mbercx What is the status of this PR?

@sphuber
Copy link
Contributor

sphuber commented May 28, 2020

This is currently on hold until we merge #4124 into develop. I was working on this together with @mbercx this morning until he suffered a power outage. I expect we should be able to merge that PR today

@csadorf
Copy link
Contributor

csadorf commented May 28, 2020

@mbercx Can you rebase this branch so that the docs are automatically build?

@mbercx mbercx force-pushed the fix/3991/docs-howto-write-workflow branch from 78a4fd9 to 03edb0c Compare May 28, 2020 15:24
@csadorf
Copy link
Contributor

csadorf commented May 28, 2020

I assume this is ready now?

sphuber
sphuber requested changes May 28, 2020
View reviewed changes
Copy link
Contributor

@sphuber sphuber 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 @mbercx , have a few suggestions

docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Show resolved Hide resolved
docs/source/howto/workflows.rst Show resolved Hide resolved
csadorf
csadorf suggested changes May 28, 2020
View reviewed changes
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Looks very good!

docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
docs/source/howto/workflows.rst Outdated Show resolved Hide resolved
mbercx and others added 2 commits May 28, 2020 23:58
@mbercx @sphuber @csadorf
Apply suggestions from code review
86258e3 
Co-authored-by: Sebastiaan Huber <mail@sphuber.net>
Co-authored-by: Carl Simon Adorf <carl.simon.adorf@gmail.com>
@mbercx
Apply reviewer suggestions part two
b8e5a1b
@mbercx
Copy link
Member Author

mbercx commented May 28, 2020

Thanks for the suggestions, @sphuber and @csadorf! I've made a first round of changes, and left some comments unresolved.

@mbercx mbercx requested review from csadorf and sphuber May 28, 2020 23:11
csadorf
csadorf approved these changes May 29, 2020
View reviewed changes
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Great! 👍 @sphuber Please merge at your discretion.

@sphuber sphuber merged commit 33968e0 into aiidateam:docs-revamp May 29, 2020
@sphuber sphuber mentioned this pull request May 29, 2020
Closed
@mbercx mbercx deleted the fix/3991/docs-howto-write-workflow branch May 29, 2020 10:01
csadorf added a commit that referenced this pull request May 29, 2020
@mbercx @sphuber @csadorf
Docs: add "How To - Writing workflows" section (#4112)
0d6756d 
Co-authored-by: Sebastiaan Huber <mail@sphuber.net>
Co-authored-by: Carl Simon Adorf <carl.simon.adorf@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sphuber sphuber sphuber approved these changes

@csadorf csadorf csadorf approved these changes

Assignees
No one assigned
Labels
topic/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: How to write workflows
3 participants
@mbercx @csadorf @sphuber