Created Documentation CHANGELOG #3558
Conversation
| Fixed Documentation | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| - `e385d28 <https://github.com/symfony/symfony-docs/commit/e385d28bee7c7418c8175d43befc4954a43a300c>`_ #3503 file extension correction xfliff to xliff (nixilla) |
There was a problem hiding this comment.
it was easier for me to link to the commit than to link to the PR. In the feature, we may change this so that it displays the changed files.
There was a problem hiding this comment.
Maybe we should think about creating an extension that makes linking to a certain commit easier.
There was a problem hiding this comment.
Yea, we can always make this change later - piece by piece :)
|
Thank you @xabbuh ! For some reason, my editor decided it was better to use tabs in reSt documents... |
This PR was merged into the 2.3 branch. Discussion ---------- Created Documentation CHANGELOG | Q | A | --- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | #2579 This is the second enhancement (after #3328) of the Symfony2 Documentation Process. This idea came from @shoomyth in #2579. Since @weaverryan is using gh to merge the Pull Requests, it's easy to scan through the commits and find the changes (I'm busy creating an automated script for this). The plan is to update the changelog each month, so people have a clear view on new articles or fixed things. It'll also be another attribution to the many symfony doc hero's! This PR lists the changes in the 2.3 branch for January. When we agree with this, it'll be update for changes in the 2.4 and master branches. My idea was to put a link to this article in the sidebar (ping @fabpot). We would love to get your opinion about this new change! Commits ------- 401737b Applied comments from @xabbuh a6c68a9 Added CHANGELOG for 2.3
|
@fabpot can you maybe update the sidebar menu with this? |
|
and of course, @weaverryan thanks! I'll take a look at the other versions and try to improve my script in the comming weeks, so we are able to just run a script every month |
|
Ping @javiereguiluz |
|
Ah, is @javiereguiluz the one which should be pnged for symfony.cœm related things? Good to know :) |
|
It's a bit new and It has been said at SymfonyCon (varsaw 2013) ;) So this is not a secret ;) |
|
I feel that there will be a lot of pings for him in the next days. ;) |
|
@javiereguiluz will hate me for that... Sorry. |
|
In the coming weeks we're going to explain publicly more details about the redesign of symfony.com. Meanwhile I can tell you that this redesign is going to be gradual, page by page. Due to the vast complexity of the documentation section, this is not going to be one of the first sections to be redesigned. Therefore, I think that we should add a link to the changelog in the current website. My question is if you just want a link to the changelog file in the repository or if you want full integration of the changelog file inside the symfony.com website. The first option would be online in a few days while the other one would require some undefined amount of time. |
|
Linking to the repository file imho is no option since most ReSt directives aren't rendered properly. However, we can use it as a temporarily solution until we have a better one I guess. |
|
@javiereguiluz I thought it would be rendered on http://symfony.com/doc/2.3/changelog.html, just like all other doc articles? Or doesn't that apply to the root files? I think in the end, we should render it online. But as a temporarily solution, we can just use the link to the repo. Since the CHANGELOG file contains only basic RST markup (no usage of fabian's sphinx extensions), there are no rendering issues on github (@xabbuh). And as it'll properbly only be used by a small group, it wouldn't make that much of a difference. |
|
I've now updated the changelog files for all branches. @javiereguiluz can you please add the link? |
This is the second enhancement (after #3328) of the Symfony2 Documentation Process.
This idea came from @shoomyth in #2579. Since @weaverryan is using gh to merge the Pull Requests, it's easy to scan through the commits and find the changes (I'm busy creating an automated script for this).
The plan is to update the changelog each month, so people have a clear view on new articles or fixed things. It'll also be another attribution to the many symfony doc hero's!
This PR lists the changes in the 2.3 branch for January. When we agree with this, it'll be update for changes in the 2.4 and master branches.
My idea was to put a link to this article in the sidebar (ping @fabpot).
We would love to get your opinion about this new change!