Skip to content

Update installation.rst #11596

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
Jun 3, 2019
Merged

Update installation.rst #11596

merged 1 commit into from
Jun 3, 2019

Conversation

janmyszkier
Copy link

update encore package name, encore is not recognized by composer currently

update encore package name, `encore` is not recognized by composer currently
@OskarStark
Copy link
Contributor

Hmm, but it should, according to the aliases named here:
https://github.com/symfony/recipes/blob/master/symfony/webpack-encore-bundle/1.0/manifest.json

encore, webpack and webpack-encore

//cc @weaverryan

@janmyszkier
Copy link
Author

🤔 so this should be bug submitted somewhere else? if this is the case, @OskarStark can you please create a bug in the correct place and add a link to it in this thread. thank you in advance.

@wouterj
Copy link
Member

wouterj commented May 30, 2019

Symfony uses symfony/flex to "ease" installation of bundles/integrations into the framework. It's a Composer plugin that you need to include as a dependency in the project if you want to use it.

Once you install it, you can use "package aliases" to install stuff. encore is such an alias (all aliases are listed on https://symfony.sh). Besides that, it also adds more great features like recipes (which create some bootstrap code related to packages you install). See https://symfony.com/doc/current/setup/flex.html for more information.

However, to not confuse people not using Flex (like I assume the project you're working on), I think we decided not to use aliases in the documentation. So 👍 on this change!

@OskarStark
Copy link
Contributor

I agree with being more clear here 👍🏻
Let’s merge

@javiereguiluz
Copy link
Member

I'm afraid I disagree here. I think that installing the bundle it's not equivalent to running the recipe, because several files and dirs are created too by the recipe.

Also, I don't think the current doc is confusing. It shows two different ways of installing this and the first one continuously mentions "Symfony Flex" and gives you some hints when you are not using that. This is how the doc is designed:

image

@janmyszkier
Copy link
Author

janmyszkier commented May 31, 2019

The thing is this IS Symfony 3.4 application (so I'm reading correct doc page I guess), except it is not using flex.
Therefore, It does not fall into the "non Symfony Applications" category. And this is counterintuitive.
Maybe, in that case, add another section for old-style package installing without flex but still within symfony?

@wouterj
Copy link
Member

wouterj commented May 31, 2019

Ref: #9693

Copy link
Member

@weaverryan weaverryan left a comment

Choose a reason for hiding this comment

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

If we’re avoiding aliases in general in the docs, then it’s a clear +1. However, it doesn’t address the issue of if a person in a non Flex app follows these instructions - the rest of the steps would be broken. In some ways, relying on the alias guarantees that you’ll get the recipe or it won’t work at all. But for now, I guess let’s go with no aliases and try to make language clear around the fact that we expect this to also execute a Flex recipe

@javiereguiluz javiereguiluz added this to the 3.4 milestone Jun 3, 2019
@javiereguiluz javiereguiluz merged commit 4d82f66 into symfony:3.4 Jun 3, 2019
javiereguiluz added a commit that referenced this pull request Jun 3, 2019
This PR was merged into the 3.4 branch.

Discussion
----------

Update installation.rst

update encore package name, `encore` is not recognized by composer currently

<!--

If your pull request fixes a BUG, use the oldest maintained branch that contains
the bug (see https://symfony.com/roadmap for the list of maintained branches).

If your pull request documents a NEW FEATURE, use the same Symfony branch where
the feature was introduced (and `master` for features of unreleased versions).

-->

Commits
-------

4d82f66 Update installation.rst
@javiereguiluz
Copy link
Member

I've merged this (and made some minor rewords in bc3107b).

I was wrong before. I've tested running both Composer commands and the results are the same, so let's remove the alias here. Thanks!

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.

6 participants