Skip to content

[Workflow] Add tip for workflow configuration default values #7315

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

Closed
wants to merge 3 commits into from
Closed

[Workflow] Add tip for workflow configuration default values #7315

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6369c9
Add tip for workflow configuration default values
dominikhajduk Jan 4, 2017
c25cb43
Add tip for workflow configuration default values
dominikhajduk Jan 8, 2017
7087f9e
Add tip for workflow configuration default values
dominikhajduk Jan 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions workflow/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,12 @@ like this:
The marking store type could be "multiple_state" or "single_state".
A single state marking store does not support a model being on multiple places
at the same time.

.. tip::

Workflow configuration ``type`` and ``arguments`` in ``marking_store`` section
are optional. You can skip one or both when you use default values. Default value
for ``type`` is "single_state". Default value for ``arguments`` is "marking".
Copy link
Member

Choose a reason for hiding this comment

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

I would reword this a bit to something like this:

The type (default value single_state) and arguments (default value marking) attributes of the marking_store option are optional. If omitted, their default values will be used.

What do you think?

Copy link
Contributor Author

@dominikhajduk dominikhajduk Jan 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@xabbuh fine for me. Will change in couple of seconds.


With this workflow named ``blog_publishing``, you can get help to decide
what actions that are allowed on a blog post. ::
Expand Down