Skip to content

[Workflow] doc improvements #11578

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.

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

Merged
merged 1 commit into from
May 17, 2019

Conversation

noniagriconomie
Copy link
Contributor

Hi,

Here are some workflow doc improvements:

  • keep as much as possible in synch the subject, places and transition in the related docs
  • change "travis" in favor of "test" (travis may not be known) + update image
  • move transition blocker via listener part into the right sub part + rewrite it

Thanks

@noniagriconomie noniagriconomie changed the title Workflow doc [Workflow] doc improvements May 16, 2019
Copy link
Contributor

@OskarStark OskarStark left a comment

Choose a reason for hiding this comment

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

With some minor comments 👍

Thank you for working out the details and making this part of the docs consistent 🎉

# run this command if you prefer SVG images:
# $ php dump-graph-dot.php | dot -Tsvg -o dot_graph.svg
$ php dump-graph-puml.php | java -jar plantuml.jar -p > puml_graph.png
Copy link
Contributor

Choose a reason for hiding this comment

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

this grouping is a bit confusing now, because it generates a png file, but follows a comment/description which is talking about svg 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

wanted to "group" dot cli vs java
i propose a new way

$ php bin/console workflow:dump workflow_name | dot -Tpng -o workflow_name.png
# run this command if you prefer SVG images:
# $ php bin/console workflow:dump workflow_name | dot -Tsvg -o workflow_name.svg
$ php bin/console workflow:dump workflow_name --dump-format=puml | java -jar plantuml.jar -p > workflow_name.png
Copy link
Contributor

Choose a reason for hiding this comment

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

same as above

@noniagriconomie
Copy link
Contributor Author

@OskarStark review/rework addressed
still unsure of the "dumping" part

@javiereguiluz javiereguiluz added this to the 4.2 milestone May 16, 2019
@javiereguiluz
Copy link
Member

Note to mergers: merge in 4.2 branch.

@OskarStark OskarStark changed the base branch from master to 4.2 May 17, 2019 06:46
@OskarStark OskarStark force-pushed the feature-workflow-doc branch from 7e65c40 to d6b8d18 Compare May 17, 2019 06:47
@OskarStark
Copy link
Contributor

OskarStark commented May 17, 2019

Thank you Antoine, I merged it in 4.2 👍

@OskarStark OskarStark merged commit d6b8d18 into symfony:4.2 May 17, 2019
OskarStark added a commit that referenced this pull request May 17, 2019
This PR was submitted for the master branch but it was merged into the 4.2 branch instead (closes #11578).

Discussion
----------

[Workflow] doc improvements

Hi,

Here are some workflow doc improvements:

- keep as much as possible in synch the subject, places and transition in the related docs
- change "travis" in favor of "test" (travis may not be known) + update image
- move transition blocker via listener part into the right sub part + rewrite it

Thanks

Commits
-------

d6b8d18 Workflow doc
@noniagriconomie noniagriconomie deleted the feature-workflow-doc branch May 17, 2019 07:39
wouterj added a commit that referenced this pull request Aug 12, 2019
This PR was merged into the 4.3 branch.

Discussion
----------

[4.3] Update workflow config

Rescued some really bad git stuff from me while merging: #11580

Original description:

> Hi,
>
> This draft PR follows this one
> https://github.com/symfony/symfony-docs/pull/11492/files (config for 3.X version)
> but for new version, mostly 4.3
>
> I checked this PR also
> symfony/symfony#30890, @lyrixx review appreciated please
>
> Maybe to merge after merging #11578, and with a rebase ?
>
> --------------------
>
> Draft for now
>
> - Closes #11229
>
> this one can be closed also:
>
> - Closes #9475
> - Closes #10197

Commits
-------

fdc221b Minor XML improvement
a640d14 [Workflow] config doc
7bb2041 Fix indent
f65f1bc Review
cf3a32c Doc config metadata
34e7cc5 [Workflow] config doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants