Documented the workflow metadata [redux] #11209
Conversation
When symfony#9465 is finished, link to details on Transition Blockers.
|
@HeahDude re "specific formatting" I've noticed the file uses a mix of When I took Javier's commits the branch ended up being created against |
Now we use the new short syntax, since the lowest supported version is 3.4 having PHP 5.5 as minimum.
4.1 was master back then, now we need to merge into 4.2 but we can do it on merge thanks to the CLI tool we use to maintain the docs. |
|
Re the code style comment above which is outstanding: Is there a linter for code examples? An automated formatter? I imagine we stick to Symfony's code style, but as Phpstorm's Symfony2 preset seems to differ in small ways from the current Symfony format, it would be good to have a definitive formatter to use. |
|
@OskarStark Your code review is showing as "Changes requested" - are you satisfied with the changes that were applied? |
|
@pbowyer This PR conflicts. Could you try to rebase it and fix the conflict? Thanks |
|
@lyrixx Of course. 4.2 is the correct one to rebase onto, I believe? |
|
Exactly 👍 You need to rebase on top of 4.2 and update the target branch on github |
Co-Authored-By: pbowyer <peter@mapledesign.co.uk>
e580f3c to
6080aa8
Compare
|
@lyrixx There we go 😁 |
|
There may be one newline missing: I think there should be a blank line between the two? |
| return; | ||
| } | ||
|
|
||
| $explanation = $event->getMetadata('explanation', $event->getTransition()); |
There was a problem hiding this comment.
@pbowyer I think you should add an explanation entry in the metadata of one publish transition so that a newcomer can directly spot the usage and the link between transition, place, etc
|
Ref to #9475 |
|
Can we merge this please? There are more PRs for Workflow coming to fruition, and if they all get approved/merged at the same time, there will be a number of conflicts... |
… pbowyer, OskarStark) This PR was merged into the 4.2 branch. Discussion ---------- Documented the workflow metadata [redux] With @javiereguiluz's permission I have taken #9476 and incorporated the comments and code examples into it. This is the start of a push to improve the Workflow documentation. The focus now is on expanding the documentation by merging pull requests; organizing it will come later. Commits ------- 7f3a0fd Oskar's feedback a4c23c1 Add blank line between code block and sentence above. Code block was not rendering. 6080aa8 Remove the word 'simple' 3765ddb Change code formatting of PHP snippet per https://github.com/symfony/symfony-docs/pull/11209/files/d57fa38d903175d58d9cfbf63f20e7ced8d2fd01#r268391655 55c9199 Indent PHP block by an additional 4 spaces 225c2fe Apply suggestions from code review f716e81 Incorporate @OskarStark's feedback 94d17de Simplify the English and turn it into a tip 40fbaf3 Update arrays to use short syntax ea64992 Incorporate further excellent feedback from @HeahDude af71c14 Add an introduction as suggested in #11209 (comment) ca66356 Document how to see all configuration options (see #11209 (comment)) c9ef262 Incorporate @OskarStark's feedback c595c47 First set of tidy-ups for @HeahDude's feedback. 663639b Incorporate the code examples in #9476 (comment) into the documentation 17eae8c Add missing metadata key, fixing comment by @noniagriconomie on #9476 d68cc99 Documented the workflow metadata
|
Thanks Peter! This has been merged ... and I'll rebase the Workflow doc reorganization (#11437) with your changes. |
|
Great work Peter, thank you 🙏 |
With @javiereguiluz's permission I have taken #9476 and incorporated the comments and code examples into it.
This is the start of a push to improve the Workflow documentation. The focus now is on expanding the documentation by merging pull requests; organizing it will come later.