Skip to content

Overhaul Deployment + a few other tweaks #8721

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 5 commits into from
Nov 24, 2017
Merged

Overhaul Deployment + a few other tweaks #8721

merged 5 commits into from
Nov 24, 2017

Conversation

weaverryan
Copy link
Member

@weaverryan weaverryan commented Nov 21, 2017

This removes all of the PAAS articles. I really like mentioning great PaaS, but it doesn't make sense for us to maintain the articles (and in practice, we don't maintain them).

So, I've removed all of the articles. Ping @dzuelke, @Crell & @ostark. I just want you guys to be aware of this :).

This updates deployment.rst to mention environment variables. But my description is SUPER weak (https://github.com/symfony/symfony-docs/pull/8721/files#diff-7691c197e7985b35df39ae74d6d58b8dR128)! My impression is that (outside a PaaS), setting environment variables is a pain, and varies widely. I want to give a better recommendation that I am right now.

We cannot maintain these and keep them up to date
@weaverryan weaverryan changed the base branch from master to 4.0 November 21, 2017 19:07
@dzuelke
Copy link
Contributor

dzuelke commented Nov 21, 2017

s/PAAS/PaaS/

@dzuelke
Copy link
Contributor

dzuelke commented Nov 21, 2017

I think this change makes sense. Maybe drop the " Cloud" suffixes from the headings (for Azure and Heroku). Also, maybe just inline the links to the official docs? Otherwise it just takes people to a one-line article that only has an external link. Or is that for keeping existing URLs intact?

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.

As you said, the env var part is vague ... but I think it's good enough. When we have more experience with this new workflow, we'll make more specific recommendations.

deployment.rst Outdated

deployment/*
deployment/heroku
Copy link
Member

Choose a reason for hiding this comment

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

Instead of linking to those dead pages here, could we instead link to the real tutorials on those third-party websites? If you do that, you need to add :orphan: at the beginning of the RST files to avoid the "this file is not linked in any TOC" error (like here: https://github.com/symfony/symfony-docs/blob/master/bundles/index.rst)

@weaverryan weaverryan mentioned this pull request Nov 21, 2017
@weaverryan
Copy link
Member Author

Great feedback - thanks guys :)

@ostark
Copy link

ostark commented Nov 22, 2017

Agree, duplicated content makes not much sense.
We are updating our Symfony guides right now for 3.4 / 4.0.

deployment.rst Outdated
.. _`Heroku`: https://devcenter.heroku.com/articles/getting-started-with-symfony
.. _`platform.sh`: https://docs.platform.sh/frameworks/symfony.html
.. _`Azure`: https://azure.microsoft.com/en-us/develop/php/
.. _`fortrabbit`: https://help.fortrabbit.com/install-symfony-3-uni
Copy link

Choose a reason for hiding this comment

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

Please use https://help.fortrabbit.com/install-symfony
This way we are not tied to the version.

Copy link
Member Author

Choose a reason for hiding this comment

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

Absolutely - much nicer link :)

@weaverryan weaverryan merged commit 3e463f6 into symfony:4.0 Nov 24, 2017
weaverryan added a commit that referenced this pull request Nov 24, 2017
This PR was squashed before being merged into the 4.0 branch (closes #8721).

Discussion
----------

Overhaul Deployment + a few other tweaks

This removes all of the PAAS articles. I *really* like mentioning great PaaS, but it doesn't make sense for us to maintain the articles (and in practice, we don't maintain them).

So, I've removed all of the articles. Ping @dzuelke, @Crell & @ostark. I just want you guys to be aware of this :).

This updates `deployment.rst` to mention environment variables. But my description is SUPER weak (https://github.com/symfony/symfony-docs/pull/8721/files#diff-7691c197e7985b35df39ae74d6d58b8dR128)! My impression is that (outside a PaaS), setting environment variables is a pain, and varies widely. I want to give a better recommendation that I am right now.

Commits
-------

3e463f6 updating link to be version independent
5b6ef2a linking directly and marking articles as orphans
9a1695d linking to missing article
bbffb1a Removing all PAAS deployment articles
b563ab2 using different example
@weaverryan weaverryan deleted the fix-parameters branch November 24, 2017 01:46
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.

5 participants