Skip to content

Tweaked the Symfony Releases page #6303

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.

Sign up for GitHub

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 2 commits into from
Mar 17, 2016
Merged

Tweaked the Symfony Releases page #6303

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4132c7e
Tweaked the Symfony Releases page
javiereguiluz Feb 24, 2016
bdfbfa7
Fixed everything suggested by reviewers
javiereguiluz Mar 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions contributing/community/releases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,21 @@ Below is the schedule for the first few versions that use this release model:
* **Blue** represents the Stabilization phase
* **Green** represents the Maintenance period

This results in very predictable dates and maintenance periods:
.. tip::
Copy link
Member

Choose a reason for hiding this comment

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

What about using .. seealso:: here?


If you want to learn more about the timeline of any given Symfony version,
use the online `timeline calculator`_. You can also get all data as a JSON
string via a URL like `https://symfony.com/roadmap.json?version=2.x`.
Copy link
Member

Choose a reason for hiding this comment

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

We need double backticks here.

Copy link
Member

Choose a reason for hiding this comment

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

The last sentence seems to be a feature that should documented on the roadmap page, not in this referencing box.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree with Wouter. A few days ago we changed the http://symfony.com/roadmap page to add a mention to this TIP:

symfony_roadmap

Would you agree if I remove this sentence from the releases.rst page?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. Btw, I like the design of the tip sentence!

Copy link
Member

Choose a reason for hiding this comment

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

I agree, makes sense to remove it now.


.. tip::

Whenever an important event related to Symfony versions happens (a version
reaches end of maintenance or a new patch version is released for
instance), you can automatically receive an email notification if you
subscribed on the `roadmap notification`_ page.
Copy link
Member

Choose a reason for hiding this comment

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

This links to the same page as the timeline calculator link. Is that intended? What about adding an anchor to the roadmap notificiation box here and to the version checker for the timeline calculator link?


Version History
---------------

======= ============== ======= ======================== ===========
Version Feature Freeze Release End of Maintenance End of Life
Expand Down Expand Up @@ -123,19 +137,6 @@ Version Feature Freeze Release End of Maintenance End of Life
.. [2] Symfony 2.8 is the last version of the Symfony 2.x branch.
.. [3] Symfony 3.0 is the first version to use the new release process based on five minor releases.

.. tip::

If you want to learn more about the timeline of any given Symfony version,
use the online `timeline calculator`_. You can also get all data as a JSON
string via a URL like `https://symfony.com/roadmap.json?version=2.x`.

.. tip::

Whenever an important event related to Symfony versions happens (a version
reaches end of maintenance or a new patch version is released for
instance), you can automatically receive an email notification if you
subscribed on the `roadmap notification`_ page.

Backwards Compatibility
-----------------------

Expand Down