8000 Improve generic deployment article · Issue #5158 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Improve generic deployment article #5158

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

Closed
wouterj opened this issue Apr 8, 2015 · 5 comments
Closed

Improve generic deployment article #5158

wouterj opened this issue Apr 8, 2015 · 5 comments
Labels
actionable Clear and specific issues ready for anyone to take them. hasPR A Pull Request has already been submitted for this issue.

Comments

@wouterj
Copy link
Member
wouterj commented Apr 8, 2015

From the article:

B) Configure your app/config/parameters.yml File

This file should not be deployed, but managed through the automatic utilities provided by Symfony.

We should better explain what the "automatic utilities" are. Afaik, it's only the incenteev parameter handler that's included in the SE? Or is there something from Symfony itself that handles his.

The step is also a bit strange as it only tells what not to do. Nothing explains what the user needs to do.

This was issue was submitted by a user on a dutch forum

@wouterj wouterj added the actionable Clear and specific issues ready for anyone to take them. label Apr 8, 2015
@juliendufresne
Copy link
juliendufresne commented May 1, 2016

It's probably not about incenteev parameter handler because if we follow the document, we have not installed any dependencies yet (done in the step after that).

I don't know if there is a tool for that. If we deploy with capistrano, Incenteev parameter handler seems not to be the solution.

The best place to store the parameters.yml file in a capistrano structure is in the shared/app/config/ directory. If we configure incenteev parameter handler to do that, then we need the same structure for our devlopment environment.

        "incenteev-parameters": {
            "dist-file": "app/config/parameters.yml.dist",
            "file": "../shared/app/config/parameters.yml"
        },

@ThibauldNuyten
Copy link
ThibauldNuyten commented Jan 20, 2017

Shit like this is why people think development is hard. It's not, people just suck at making documentation for just about anything.

I lost count how many times I read a tutorial where lots of critical information was missing. Critical meaning information absolutely required to finish the exercise. i.e. lots of times I've seen tutorials that would say "add xyz code to your project", without specifying where in the project to place that code, or in which file, or exactly where in the file it should be placed. Also often missing is what exactly the code does, and why it's there/needed in the first place.

Coding is the new magic. You say (type) a few words, and things happen, but no one is expected to know what those words do anymore. Frameworks were a blessing, but the more I get into them the worse this shit gets. There is absolutely no point in adding a function to your framework if the documentation for it sucks or is nonexistent.

Documentation is the thing you use to tell other people what your function does. If you fuck it up/leave things out, how on earth is anyone supposed to know what that function does?

@javiereguiluz
Copy link
Member

@ThibauldNuyten I totally agree with you! That's why I love Symfony documentation. Everything works, you can copy+paste the code, they even include the necessary use ... statements in case you don't use an IDE, they most of the times explain to you some details about how you should do things in that way, etc. In fact, the worst part about the Symfony Docs is that it creates impossibly high expectations for other projects and whenever you look at other projects docs ... you get disappointed :(

In the particular case of this article, the problem is that it's a vague and generic article on purpose. We have dedicated articles to explain step-by-step how to deploy Symfony apps to Azure, Heroku, etc. But this article is about some general notes and comments about deploying ... so it will always miss information needed in your particular case :( I can't think of a solution to this problem.

@juliendufresne
Copy link
juliendufresne commented Jan 22, 2017

@javiereguiluz I totally agree with you when you say that the Symfony Documentation is awesome and contains plenty of information.

But for this case, I still don't understand what the quote from @wouterj refers to

the automatic utilities provided by Symfony

This quote is still present in the current documentation.

Which automatic utility is it referring to?
As I said in my previous comment, it can not be the incenteev/composer-parameter-handler package because it uses the parameters.yml.dist file which is under version control (so it should not contains critical information such as production environment credentials).
I don't know any "tool provided by symfony" able to manage the parameters.yml file in the production environment.

@garek007
Copy link

Yes I am wondering what "automatic utilities" are myself. I agree with ThibauldNuyten.

@javiereguiluz javiereguiluz added the hasPR A Pull Request has already been submitted for this issue. label Jul 5, 2017
xabbuh added a commit that referenced this issue Jul 11, 2017
…l (javiereguiluz)

This PR was squashed before being merged into the 2.7 branch (closes #8122).

Discussion
----------

Improved the explanation about deployment + parameters.yml

This fixes #5158.

As usual, the explanations in this article are a bit vague, because this is a generic deployment article and it contains no details (we have dedicated articles to explain those details).

Commits
-------

186458c Improved the explanation about deployment + parameters.yml
@xabbuh xabbuh closed this as completed Jul 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Development

No branches or pull requests

6 participants
0