Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork9.7k
Updated all the README files#17997
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| [send Pull Requests](https://github.com/symfony/symfony/pulls) | ||
| in the[main Symfony repository](https://github.com/symfony/symfony) | ||
| Third Party Dependencies |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this is not really a dependency. The next paragraph is explaining where the implementation comes from
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I've changed it byCredits, which is the term used by Google to mention the licenses of the projects they use:
javiereguiluz commentedMar 3, 2016
@stof I've done all the changes. Thanks for the review! |
fabpot commentedMar 3, 2016
@javiereguiluz But you probably forgot to push :) |
javiereguiluz commentedMar 3, 2016
I've removed all the old stuff included in the READMEs. Now we just explain briefly the purpose of each component using the same brief explanation showed in Symfony Docs. |
| from the ICU library. | ||
| The replacement layer is limited to the locale "en". If you want to use other | ||
| locales, you should[install the intl extension][0] instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this paragraph should be kept IMO, as we don't provide a full replacement
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
You are right. Done. Thanks.
nicolas-grekas commentedMar 3, 2016
👍 |
fabpot commentedMar 4, 2016
Thank you@javiereguiluz. |
This PR was squashed before being merged into the 2.3 branch (closes#17997).Discussion----------Updated all the README files| Q | A| ------------- | ---| Branch | 2.3| Bug fix? | no| New feature? | no| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets | -| License | MIT| Doc PR | -Related to#17995.Commits-------2e81248 Updated all the README files
This PR was merged into the 2.3 branch.Discussion----------Add README files where missing| Q | A| ------------- | ---| Branch | 2.3| Bug fix? | no| New feature? | no| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets |#17997| License | MIT| Doc PR |The bundles as well as the Swiftmailer bridge did not have readme files.Commits-------a1997b9 add readme files where missing
This PR was merged into the 2.7 branch.Discussion----------[2.7] update readme files for new components| Q | A| ------------- | ---| Branch | 2.7| Bug fix? | no| New feature? | no| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets |#17997| License | MIT| Doc PR |This completes@javiereguiluz's great work from#17997 by adapting the readme files of components added after the release of Symfony 2.3.Commits-------5ba194e [2.7] update readme files for new components
This PR was merged into the 2.8 branch.Discussion----------[2.8] update readme files for new components| Q | A| ------------- | ---| Branch | 2.8| Bug fix? | no| New feature? | no| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets |#17997| License | MIT| Doc PR |This completes@javiereguiluz's great work from#17997 by adapting the readme files of components added in Symfony 2.8.Commits-------897ca7f [2.8] update readme files for new components
wouterj commentedMar 11, 2016
What's the reason behind removing all code examples? I think these examples are great, as they allow people to get a real quick overview of the component. Also, some components are far from being fully documented, the (now removed) examples were the docs for that component. |
javiereguiluz commentedMar 12, 2016
@wouterj most of the times this doc was duplicated. Besides, no one maintained it and some components showed a very outdated info. If you think the removed docs are good enough, we could use them as the temporary doc of each undocumented component. |
Related to#17995.