Skip to content

Workflow dump images don't match with configuration from workflow docs #16324

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
Closed
andrew-demb opened this issue Dec 24, 2021 · 4 comments · Fixed by #17109
Closed

Workflow dump images don't match with configuration from workflow docs #16324

andrew-demb opened this issue Dec 24, 2021 · 4 comments · Fixed by #17109
Labels
hasPR A Pull Request has already been submitted for this issue. Workflow

Comments

@andrew-demb
Copy link
Contributor

Dumped images workflow (https://symfony.com/doc/current/workflow/dumping-workflows.html) differs from configuration in previous docs page about workflow component usage (https://symfony.com/doc/current/workflow.html#creating-a-workflow).

Example difference between PlantUML images:
from docs website image_diagram_from_docs

generated from config image_diagram_from_config

Should we sync base workflow configuration and regenerate images to allow matching them by developer with configuration from docs?
Or provide a new workflow config used for generating image in https://symfony.com/doc/current/workflow/dumping-workflows.html ?
@94noni
Copy link
Contributor

94noni commented Aug 3, 2022

@andrew-demb I think yes, we should regenerate new images based on changes on the workflow config
do you have the tools locally to do so?

@andrew-demb
Copy link
Contributor Author

@94noni Yes, I do.

There are generated images from docs config (https://symfony.com/doc/current/workflow.html#creating-a-workflow):

  1. graphviz dot
    dot_graph
  1. plantuml
    plantuml_graph
  1. mermaid
    mermaid_graph

@94noni
Copy link
Contributor

94noni commented Aug 3, 2022

May you open a doc PR with those? Could be very valuable to match code and dump images :)

andrew-demb added a commit to andrew-demb/symfony-docs that referenced this issue Aug 3, 2022
@andrew-demb
symfony#16324 Sync workflow images with provided configuration on docs
3d3e393
@andrew-demb andrew-demb mentioned this issue Aug 3, 2022
Merged
@andrew-demb
Copy link
Contributor Author

@94noni PR landed

@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Aug 4, 2022
javiereguiluz added a commit that referenced this issue Aug 4, 2022
@javiereguiluz
minor #17109 [Workflow] #16324 Sync workflow images with provided con…
08b2633 
…figuration on docs (andrew-demb)

This PR was merged into the 5.4 branch.

Discussion
----------

[Workflow] #16324 Sync workflow images with provided configuration on docs

<!--

If your pull request fixes a BUG, use the oldest maintained branch that contains
the bug (see https://symfony.com/releases for the list of maintained branches).

If your pull request documents a NEW FEATURE, use the same Symfony branch where
the feature was introduced (and `6.x` for features of unreleased versions).

-->
Ref: #16324
Actualize images according to provided workflow configuration in workflow documentation (https://symfony.com/doc/current/workflow.html#creating-a-workflow)

Commits
-------

3d3e393 #16324 Sync workflow images with provided configuration on docs
javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this issue Aug 4, 2022
@javiereguiluz
Merge branch '5.4' into 6.0
9802e6d 
* 5.4:
  symfony#16324 Sync workflow images with provided configuration on docs
javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this issue Aug 4, 2022
@javiereguiluz
Merge branch '6.0' into 6.1
57a9c3a 
* 6.0:
  symfony#16324 Sync workflow images with provided configuration on docs
javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this issue Aug 4, 2022
@javiereguiluz
Merge branch '6.1' into 6.2
3964d9d 
* 6.1:
  symfony#16324 Sync workflow images with provided configuration on docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hasPR A Pull Request has already been submitted for this issue. Workflow
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Workflow] Sync workflow images with provided configuration on docs andrew-demb/symfony-docs
3 participants
@94noni @xabbuh @andrew-demb