Skip to content

Added a new article about using/installing unstable Symfony versions #5186

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 15 commits into from
Jun 27, 2015

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets -

In addition to the new article, I propose to move the existing upgrading.rst article to the new "Installing and Upgrading" section. New articles related to this topic will be added soon. I plan to add at least two articles:

  • How to install Symfony with Composer (this will allow us to simplify installation instructions across the documentation and just recommend to use the installer).
  • How to install Symfony in a Subdirectory (it's not uncommon to have to execute Symfony apps in URLs such as example.com/my-symfony-app/ It's not hard, but at least you have to configure the router.request_context.base_url config option, which I think is documented nowhere).

In this article you'll learn how to install and use new Symfony versions before
they are released as stable versions.

Creating a New Project Based on an Inestable Symfony Version
Copy link
Contributor

Choose a reason for hiding this comment

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

Unstable should be used imo

@cordoval
Copy link
Contributor

nice trick about router.request_context.base_url 👍

@javiereguiluz javiereguiluz changed the title Added a new articule about using/installing inestable Symfony versions Added a new articule about using/installing unstable Symfony versions Apr 17, 2015
@stof
Copy link
Member

stof commented Apr 17, 2015

@javiereguiluz configuring router.request_context.base_url is necessary only for using the router in the CLI, just like other router parameters (during the handling of a request, all these settings are overwritten based on the Request anyway). so the right place to document this parameter is in the existing cookbook article about these parameters (it is probably missing because of the fact that it was introduced later than other parameters)

// ...
"symfony/symfony" : "2.7.*"
},
"minimum-stability": "dev"
Copy link
Member

Choose a reason for hiding this comment

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

or better "symfony/symfony" : "2.7.*@dev" to install only Symfony dev version, and not your whole ecosystem.

Copy link
Member Author

Choose a reason for hiding this comment

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

You are right. I've simplified everything to not use the minimum-stability option. Thanks!

@javiereguiluz javiereguiluz changed the title Added a new articule about using/installing unstable Symfony versions Added a new article about using/installing unstable Symfony versions Apr 17, 2015
@stof
Copy link
Member

stof commented Apr 17, 2015

don't forget to add the old URL of the upgrading article in the redirection map

$ composer update

If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constraint
by ``"2.7.*@beta1"`` (or any other beta number).
Copy link
Member

Choose a reason for hiding this comment

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

you cannot put a beta number in the stability flag. It is either 2.7.0-beta1 (i.e. explicit version constraint for a single version, which automatically adds a stability flag for thet package given it is a root requirement involving a beta version), or 2.7.*@beta (getting the most recent version of Symfony being at least in beta stability)

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the explanation. I've reworded as:

If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constraint
by ``"2.7.0-beta1"`` to install a specific beta number or ``2.7.*@beta`` to get
the most recent beta version.

@wouterj
Copy link
Member

wouterj commented Apr 17, 2015

I propose to instead of mixing upgrading and installing, just have a section about installing (created by this PR) and one about upgrading (created by #5155).

@javiereguiluz
Copy link
Member Author

I've added all the suggestions made by reviewers.

Regarding the proposal made by @wouterj, I don't agree with it because I think installing and upgrading Symfony are closely related topics. Moreover, splitting this small section would produce two very tiny sections.

@javiereguiluz
Copy link
Member Author

Can we considered this PR finished?

@xabbuh
Copy link
Member

xabbuh commented May 23, 2015

We just need to find a consensus on whether or not to do the split (see #5155).

@@ -0,0 +1,82 @@
How to Install and Use an Unstable Symfony Version
Copy link
Member

Choose a reason for hiding this comment

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

I'd change this - I thought "unstable" at first meant an "old, unsupported" version (e.g. 2.4)". I know that's not logical, but that's what I thought :). How about:

How to Install or Upgrade to the Latest, Unreleased Symfony Version

@weaverryan
Copy link
Member

FWIW - my vote is to keep these as 2 sections: #5155 (comment)

Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in
May and one in November (:doc:`see releases detail </contributing/community/releases>`).
Testing the new Symfony versions in your projects as soon as possible is important
to ensure that they will keep working after upgrading to the new version.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this paragraph adds enough value


Instead of creating a new empty project, in this section you'll update an existing
Symfony application to an unstable framework version. Suppose again that Symfony
2.7 version hasn't been released yet and you want to test it in your project.
Copy link
Member

Choose a reason for hiding this comment

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

How about just:

Suppose again that Symfony 2.7 hasn't been released yet and you want to upgrade an existing
application to test that your project works with it.

@javiereguiluz javiereguiluz force-pushed the use_inestable_version branch from 621e2ab to 1378ec9 Compare May 30, 2015 08:38
@javiereguiluz
Copy link
Member Author

I've just fixed the last issues of this PR. The only remaining issue is the split suggested by Ryan. I don't mind doing that split, but I don't like doing that in this PR because it's already complex enough. Could we reorder the contents in a further separate PR? Thanks.

@wouterj
Copy link
Member

wouterj commented Jun 25, 2015

I'm sorry, but why is the split too complex? You added one article in this PR and all you need to do is remove the changes related to the upgrade -> install/upgrade move you also added in this PR. It would make this PR less complex.

Merging this PR in the current state makes things really weird, as the upgrade article is already moved to its own upgrading section.

@weaverryan weaverryan merged commit 8e8fad2 into symfony:2.3 Jun 27, 2015
weaverryan added a commit that referenced this pull request Jun 27, 2015
…fony versions (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Added a new article about using/installing unstable Symfony versions

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | -

In addition to the new article, I propose to move the existing `upgrading.rst` article to the new "Installing and Upgrading" section. New articles related to this topic will be added soon. I plan to add at least two articles:

  * How to install Symfony with Composer (this will allow us to simplify installation instructions across the documentation and just recommend to use the installer).
  * How to install Symfony in a Subdirectory (it's not uncommon to have to execute Symfony apps in URLs such as example.com/my-symfony-app/  It's not hard, but at least you have to configure the `router.request_context.base_url` config option, which I think is documented nowhere).

Commits
-------

8e8fad2 Removed some wrong labels
1378ec9 Added a note about the Symfony Upgrading Guide
224c380 Fixed a lot of issues pointed by Ryan
d5f3d82 Minor improvement in a command
038caa5 Fixed minor issues
bae8043 Fixed the beta version constraints
a9fee2f Fixed a link to an internal document
caff8d2 Minor rewording
e1f621e Added a new entry in the redirection_map
724c17f Simplified instructions
6d6303c Fixed a minor error in some index file
719e52c Added the missing file extension
2722933 Fixed articles links
df22b75 Fixed typo: "inestable" -> "unstable"
402f5d4 Added a new articule about using/installing inestable Symfony versions
weaverryan added a commit that referenced this pull request Jun 27, 2015
…uments in its own section

So, this is not really removing anything - it's just that this article was "moved" originally,
in #5186, but then later on a rebase, it appeared that this upgrading.rst was "added".

The result is the intention of the #5186 PR: to add a new "install" section with
*just* the new "unstable" article.
@weaverryan
Copy link
Member

Hey guys!

I merged this in, and got all the "moving" things cleared up at sha: 875f4ee

If you see any issues, let me know!

Thanks!

@javiereguiluz javiereguiluz deleted the use_inestable_version branch May 24, 2018 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants