Skip to content

Adding version option #13472

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 30, 2020
Merged

Adding version option #13472

merged 1 commit into from
Jun 30, 2020

Conversation

wow-apps
Copy link
Contributor

@wow-apps wow-apps commented Apr 1, 2020

Added version option to setup selected version in doc

Added version option to setup selected version in doc
@wow-apps
Copy link
Contributor Author

wow-apps commented Apr 1, 2020

can someone check - CI brokes, but not by a PR fault ...?
https://github.com/symfony/symfony-docs/pull/13472/checks?check_run_id=551939846#step:7:10

@fabpot I think, it will be good for newbies to add version option for a non-latest release docs

@javiereguiluz
Copy link
Member

@wow-apps I'm sorry about the CI errors. They have been fixed now (it's not necessary, but you can rebase this PR if you want to get rid of those errors).

@wow-apps
Copy link
Contributor Author

wow-apps commented Apr 1, 2020

@javiereguiluz no worries. But I think, I should rebase, because it will be closed for merging without all steps passed

Copy link
Contributor

@dbrumann dbrumann left a comment

Choose a reason for hiding this comment

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

I do not think adding this is a good idea. We will frequently need to update this and I don't see a need for "encouraging" using a specific (older) version for a new project. My personal recommendation is to always go with the latest version anyway when starting a project. Updating to a next minor release is (mostly) safe thanks to BC promise and should be fairly easy during the initial development phases. If necessary one can decide to stop at next LTS for a slower update cycle and have the benefit of all current features.

@wow-apps
Copy link
Contributor Author

wow-apps commented Apr 7, 2020

@dbrumann
Here's live case: I need to create a consumer for RabbitMQ, but AMQBundle didn't support version 5 ;)

You're right, that better to select the latest version for a new project but version 4.4 still supported and client can decide which version he needs...

@skmedix
Copy link
Contributor

skmedix commented Apr 7, 2020

I don't like this, as versions in commands are already selected in LTS section, and every minor someone would has to change those commands. Information about --version is really not that far away in the doc. (But info about LTS could be higher I guess) Also if we go further with that idea, we have to add versions to composer require commands for every component, as versions are not specified there.

If it's really needed, then composer commands should point version ^4.4 not v4.4.99.

@dbrumann
Copy link
Contributor

dbrumann commented Apr 7, 2020

@wow-apps I get that there are use cases for picking older versions, but in my opinion the default should be the current version.

How about instead, in between the paragraphs (L55) we add a tip that you can select a version during setup with the --version-option? This way the current default can be kept and we still can tell people how to pick a different version.

@wow-apps
Copy link
Contributor Author

wow-apps commented Apr 8, 2020

@dbrumann
That fix was not for default ... but for 4.4 version.
Yes, sure, we can add tip ... I'll change it

@skmedix
The problem is when you change Symfony version in documentation - you see installation command for the latest version, not for choosed.

Copy link
Contributor

@dbrumann dbrumann left a comment

Choose a reason for hiding this comment

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

It finally made click for me, why you make this change. It's only supposed for 4.4-docs and not supposed to be merged upwards, so that the docs reflect the current way of starting a project with the same version of the docs being viewed. That makes sense to me. Sorry, for not catching that sooner. In that case I would only suggest to change the version for the composer command.

@javiereguiluz
Copy link
Member

Alexey, thanks and congrats on your first Symfony Docs contribution!

Sorry it took us so long to merge. While merging, I updated the version numbers for each branch. Thanks!

@javiereguiluz javiereguiluz merged commit 1bb6a31 into symfony:4.4 Jun 30, 2020
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