[Workflow] Add info about MermaidDumper #15102
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wouterj
approved these changes
Mar 14, 2021
There was a problem hiding this comment.
Hi @eFrane. You are today's hero for taking the time to document a future you proposed on the code!
I've left 3 markup related comments (reStructuredText has some overly complex syntax). Don't worry about these, we can also fix them while merging.
| @@ -9,6 +9,7 @@ them as SVG or PNG images. First, install any of these free and open source | ||
| applications needed to generate the images: | ||
|
|
||
| * `Graphviz`_, provides the ``dot`` command; | ||
| * `Mermaid CLI`, provides the ``mmdc``command; | ||
| * `PlantUML`_, provides the ``plantuml.jar`` file (which requires Java). | ||
|
|
There was a problem hiding this comment.
We also tell people about new features using a versionadded block:
Suggested change
| .. versionadded:: 5.3 | |
| The ``mermaid`` dump format was introduced in Symfony 5.3. |
There was a problem hiding this comment.
While I fixed the other issues, I left out this one as the feature PR is not yet merged and although there's still plenty of time until 5.3 I erred on the cautious side.
c2e2aa0 to
b7e0fe2
Compare
lyrixx
added a commit
to symfony/symfony
that referenced
this pull request
Apr 13, 2021
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [Workflow] Add Mermaid.js dumper | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #40165 | License | MIT | Doc PR | symfony/symfony-docs#15102 Mermaid is - next to PlantUML - one of the most popular simple graphing solutions. This workflow dumper mirrors the feature set of the PlantUML dumper except that Mermaid does not currently support colored transitions. **Things I need help with:** - ~I basically tried to copy the code style of the surrounding files and hope everything is conforming. Please let me know if I missed something.~ I see, that's the magic of fabbot. Nice. ❤️ - There are currently no tests for the different graph direction constants, I can add those, just did not see value in doing so yet. - I am unsure how to integrate this with the current documentation. This however is likely better discussed in the corresponding issue (see above). Commits ------- ada6f7d [Workflow] Add Mermaid.js dumper
symfony-splitter
pushed a commit
to symfony/workflow
that referenced
this pull request
Apr 13, 2021
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [Workflow] Add Mermaid.js dumper | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #40165 | License | MIT | Doc PR | symfony/symfony-docs#15102 Mermaid is - next to PlantUML - one of the most popular simple graphing solutions. This workflow dumper mirrors the feature set of the PlantUML dumper except that Mermaid does not currently support colored transitions. **Things I need help with:** - ~I basically tried to copy the code style of the surrounding files and hope everything is conforming. Please let me know if I missed something.~ I see, that's the magic of fabbot. Nice. ❤️ - There are currently no tests for the different graph direction constants, I can add those, just did not see value in doing so yet. - I am unsure how to integrate this with the current documentation. This however is likely better discussed in the corresponding issue (see above). Commits ------- ada6f7d315 [Workflow] Add Mermaid.js dumper
symfony-splitter
pushed a commit
to symfony/framework-bundle
that referenced
this pull request
Apr 13, 2021
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [Workflow] Add Mermaid.js dumper | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #40165 | License | MIT | Doc PR | symfony/symfony-docs#15102 Mermaid is - next to PlantUML - one of the most popular simple graphing solutions. This workflow dumper mirrors the feature set of the PlantUML dumper except that Mermaid does not currently support colored transitions. **Things I need help with:** - ~I basically tried to copy the code style of the surrounding files and hope everything is conforming. Please let me know if I missed something.~ I see, that's the magic of fabbot. Nice. ❤️ - There are currently no tests for the different graph direction constants, I can add those, just did not see value in doing so yet. - I am unsure how to integrate this with the current documentation. This however is likely better discussed in the corresponding issue (see above). Commits ------- ada6f7d315 [Workflow] Add Mermaid.js dumper
[Workflow] rst syntax fixes
b7e0fe2 to
b7340c7
Compare
|
Thank you @eFrane and congratulations with your first contributions! :) Fyi, I've added the versionadded box while merging the PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the documentation for symfony/symfony#40171.