Updated the best practices article for reusable bundles #5014
Conversation
javiereguiluz
commented
Feb 19, 2015
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | no |
| Applies to | 2.3+ |
| Fixed tickets | #3616 |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
you should remove the serial comma before "and"
|
@wouterj thanks for your review. I've fixed everything. |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
do we need the word technical here?
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
it is also used for the bundle configuration in config files
|
The PR has been updated with all your suggestions. |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
no, bundle is in fact just a namespace or a name to refer to a location on the filesystem
|
Maybe we should add something about the |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
might not exists could confuse (because the content exists)? any ideas for a better wording here?
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
What do you think about shortening the table borders?
|
Other best practices for shared bundles IMO:
|
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
LICENSE file may also live in the root directory directly (see #4335)
|
This also fixes #4335 |
|
I've implemented all the changes suggested by reviewers and I've rebased it. I hope this PR can be finally ready to be merged. Thanks. |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
These two lines need to be indented too to be treated as part of the list item.
|
@javiereguiluz There is one minor issue with the list syntax and it seems that the installation instructions for the rst format got lost when rebasing. Besides these two things the PR looks great! 👍 |
|
@xabbuh I'm really sorry for having lost some information during the rebase :( I really wish I haven't lost anything else during the rebase. Thanks for your help! |
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
by the way, using a definition list rather than an unordered list looks more reasonable to me
There was a problem hiding this comment.
I agree. I've reworded it as a definition list. Thanks.
cookbook/bundles/best_practices.rst
Outdated
There was a problem hiding this comment.
Will it render properly without a blank line between the entries?
There was a problem hiding this comment.
I don't know ... so I've added a blank line as suggested. Thanks.
|
👍 |
… (javiereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Updated the best practices article for reusable bundles | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | #3616 Commits ------- 286631d Added a blank line beteen definition list items 776eaee Reworded as a definition list 4276ced Added back some information wrongly removed during the rebase fa0b902 Fixed a minor syntax issue 9981193 Minor fixes and added a cross link a391563 Updated the best practices article for reusable bundles
|
Awesomesauce! Merged with very minor tweaks at sha: e15eb21 |