8000 [Translation][Debug] Add installation and minimal example to README by wouterj · Pull Request #35552 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[Translation][Debug] Add installation and minimal example to README #35552

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2020

Conversation

wouterj
Copy link
Member
@wouterj wouterj commented Feb 1, 2020
Q A
Branch? 3.4
Bug fix? no
New feature? no
Deprecations? no
Tickets n/a
License MIT
Doc PR -

At SymfonyCon, we decided to test out removing some component documentation from the official docs. These were duplicating quite some information of the main guides and were confusing people that used the components in the framework.

I think it's good to reintroduced the composer installation command and a very minimal example in the README's of the component. This doesn't require maintenance and can kickstart people to gain knowledge on how to use the component.

For now, we've (re)moved the Debug and Translation component docs, so that's why I've only modified those README's.

cc @symfony/team-symfony-docs

Copy link
Member
@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for taking care of this Wouter.

@nicolas-grekas nicolas-grekas added this to the 3.4 milestone Feb 3, 2020
@fabpot fabpot force-pushed the readme/debug-translation branch from 5177a9a to b52b7b9 Compare February 3, 2020 15:10
@fabpot
Copy link
Member
fabpot commented Feb 3, 2020

Thank you @wouterj.

8000

fabpot added a commit that referenced this pull request Feb 3, 2020
…e to README (wouterj)

This PR was squashed before being merged into the 3.4 branch (closes #35552).

Discussion
----------

[Translation][Debug] Add installation and minimal example to README

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | n/a
| License       | MIT
| Doc PR        | -

At SymfonyCon, we decided to test out removing some component documentation from the official docs. These were duplicating quite some information of the main guides and were confusing people that used the components in the framework.

I think it's good to reintroduced the composer installation command and a very minimal example in the README's of the component. This doesn't require maintenance and can kickstart people to gain knowledge on how to use the component.

For now, we've (re)moved the Debug and Translation component docs, so that's why I've only modified those README's.

cc @symfony/team-symfony-docs

Commits
-------

b52b7b9 [Translation][Debug] Add installation and minimal example to README
@fabpot fabpot merged commit b52b7b9 into symfony:3.4 Feb 3, 2020
@wouterj wouterj deleted the readme/debug-translation branch February 3, 2020 15:13
fabpot added a commit that referenced this pull request Apr 4, 2020
… (wouterj)

This PR was merged into the 4.4 branch.

Discussion
----------

[Routing] Add installation and minimal example to README

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | n/a
| License       | MIT
| Doc PR        | symfony/symfony-docs#13431

Similair to what I did in #35552, this PR updates the README of the Routing component to include a minimal example and installation command.

Commits
-------

be66120 Add installation and minimal example to README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants
0