[Heroku] A few more tweaks to outline the steps #4601
Merged
Conversation
This file contains 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
|
|
||
| Then you'll be ready for the last step: | ||
|
|
||
| 3. `Push your Code to Heroku <3) Push your Code to Heroku>`_ |
There was a problem hiding this comment.
I don't believe this works, as it's now looking for a file named 3) Push your Code to Heroku. You have to add reference anchors above these headlines and use that.
There was a problem hiding this comment.
you're right - I had never tried this before, but it doesn't work. Fixed now, and it looks better anyways :)
e80038b to
4ee7cef
Compare
|
Not sure I'd label the sub-section titles with "1)", "2)" and "3)". That's a very unusual thing to do IMO. |
|
@dzuelke Hmm, I can't prove which is better obviously. I've done this in docs in the past with the thinking (right or wrong) that I'm outlining the 3 exact steps you need, and then you're following those exact 3 steps very easily - 1, 2 then 3. To try to push my agenda further - 😇 - if someone linked you to step 2 directly, you might then say "huh, this is step 2 - what's step 1? Did I do that yet?". |
|
I also prefer to number headlines when to describe a clear step by step plan, like these 3 sections. |
|
|
||
| 2. :ref:`Set the Environment to prod <heroku-setting-env-to-prod>` | ||
|
|
||
| Then you'll be ready for the last step: |
There was a problem hiding this comment.
I don't like this comment. Since this is a step-by-step section, it's very clear already that you have to do (1) and (2) before doing (3). When ommitting this, you can also use the very nice #. list :)
|
ping @weaverryan |
weaverryan
added a commit
that referenced
this pull request
Mar 15, 2015
This PR was merged into the 2.3 branch. Discussion ---------- [Heroku] A few more tweaks to outline the steps | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | n/a Hey guys! This is just a tweak to #4591 - it's just a minor organizational thing so that (hopefully) it's even more clear what 3 steps you need to take. Thanks! Commits ------- 8c7e3b2 Changing to #. format 4ee7cef A few more tweaks to outline the steps
xabbuh
added a commit
to xabbuh/symfony-docs
that referenced
this pull request
Mar 21, 2015
* fixing a number (there are three items, not only two) * add labels for old anchors for BC
weaverryan
added a commit
that referenced
this pull request
Mar 24, 2015
This PR was merged into the 2.3 branch. Discussion ---------- [Cookbook][Deployment] some tweaks to #4601 | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | #4601 * fixing a number (there are three items, not only two) * add labels for old anchors for BC Commits ------- a90def1 some tweaks to #4601
weaverryan
added a commit
that referenced
this pull request
Mar 24, 2015
* 2.3: (44 commits) Removed duplicate "long"s terminate file with newline move title back and move description to separate file as suggested in PR #4892 move title out of included file as suggested in PR #4892 Add possible values for widget_type [#4842] Making 2 sentences changes as suggested by WouterJ in pull request #4842 Add meaning of yellow icon for number of queries Fixing bad link name fix typo in event flow diagrams Many fixes thanks to stof, WouterJ, xabbuh and dupuchba added Jakub as a merger for the DomCrawler component [#5094] Removing mkdir - it's not needed (thanks xabbuh) some tweaks to #4601 Moving index down to correct section [#4989] Language tweaks and making the example simpler Remove useless setLocale() call and add code block with locale setter Finaly touches on translation locale setting note Review note about setting the translator locale in a controller. Update translation.rst ... Conflicts: cookbook/security/entity_provider.rst
weaverryan
added a commit
that referenced
this pull request
Mar 24, 2015
* 2.6: (45 commits) Removed duplicate "long"s terminate file with newline move title back and move description to separate file as suggested in PR #4892 move title out of included file as suggested in PR #4892 Add possible values for widget_type [#4842] Making 2 sentences changes as suggested by WouterJ in pull request #4842 Add meaning of yellow icon for number of queries Fixing bad link name fix typo in event flow diagrams Many fixes thanks to stof, WouterJ, xabbuh and dupuchba added Jakub as a merger for the DomCrawler component [#5094] Removing mkdir - it's not needed (thanks xabbuh) some tweaks to #4601 Moving index down to correct section [#4989] Language tweaks and making the example simpler Remove useless setLocale() call and add code block with locale setter Finaly touches on translation locale setting note Review note about setting the translator locale in a controller. Update translation.rst ...
weaverryan
added a commit
that referenced
this pull request
Mar 24, 2015
* 2.7: (47 commits) Removed duplicate "long"s terminate file with newline move title back and move description to separate file as suggested in PR #4892 move title out of included file as suggested in PR #4892 Add possible values for widget_type [#4842] Making 2 sentences changes as suggested by WouterJ in pull request #4842 Add meaning of yellow icon for number of queries Fixing bad link name fix typo in event flow diagrams Many fixes thanks to stof, WouterJ, xabbuh and dupuchba added Jakub as a merger for the DomCrawler component Changes thanks to WouterJ and xabbuh [#5094] Removing mkdir - it's not needed (thanks xabbuh) some tweaks to #4601 Moving index down to correct section [#4989] Language tweaks and making the example simpler Remove useless setLocale() call and add code block with locale setter Finaly touches on translation locale setting note Review note about setting the translator locale in a controller. ...
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.
Hey guys!
This is just a tweak to #4591 - it's just a minor organizational thing so that (hopefully) it's even more clear what 3 steps you need to take.
Thanks!