DocBlox is unmasked … it is really phpDocumentor 2!
Posted on | March 16, 2012 | 12 Comments
Announcing phpDocumentor 2 – the merging of the old (phpDocumentor) and the new (DocBlox).
With the first alpha release of phpDocumentor (2.0.0a1), the new “Responsive” default template sports a new page layout, along with the useful layout improvements that the original DocBlox templates provided (which remain available) over the old phpDocumentor templates (which will retire with old phpDocumentor). Explore this new template at http://demo.phpdoc.org/Responsive/index.html.
*But what will this mean for DocBlox and phpDocumentor users?*
Old phpDocumentor is retiring. Some bugfix effort may continue into bringing phpDocumentor 1.x to a close, but most effort going forward will be spent on 2.x. On that 2.xeffort, you can expect monthly releases as 2.0.0 stabilizes, followed by monthly releases for new features and bug maintenance.
Existing DocBlox resources will be rebranded rather than removed, so that existing contributors can “come along for the ride” without much effort.
Let us know what you think, at #phpdocumentor on Freenode and @phpDocumentor on Twitter.
Mike van Riel (@mvriel) and Chuck Burgess (@ashnazg)
phpDoc2
is given a life anew
by DocBlox and you.
Comments
12 Responses to “DocBlox is unmasked … it is really phpDocumentor 2!”
Leave a Reply
March 16th, 2012 @ 3:46 pm
[...] DocBlox is unmasked … it is really phpDocumentor 2! : DocBlox. This entry was posted in PHP, Programming. Bookmark the permalink. ← Complex Societies [...]
March 16th, 2012 @ 5:27 pm
The demo looks great. It’s a little loose in some views though making you think where you need to click. It’s a huge improvement and a step in the right direction!!
March 16th, 2012 @ 10:47 pm
[...] relation to the news that DocBlox has merged with phpDoc to form phpDocumentor 2, I’ve updated/renamed the [...]
March 19th, 2012 @ 5:20 pm
This is good news. It was obvious from the start that DocBlox was the future and phpDocumentor (v1) was doomed.
A few questions though:
1. The phpDocumentor site talks about v2, but doesn’t mention it being an alpha release. What is the current status?
2. Also, how long before it comes out of alpha?
3. Apart from the name, what are the changes between the last docBlox release and the first phpDocumentor v2 release?
4. What will happen to the docBlox project, website, pear repositories, etc?
That’s all I can think of for the moment.
Thank you!
March 19th, 2012 @ 5:41 pm
Hi Simon,
Thank you for your kind words.
I’ll try to answer your questions to the best of my abilities:
1. phpDocumentor 2 is currently in alpha state; there are a few bugs remaining that we want gone before going stable.
2. Hard to say up front; currently our Github issue tracker has a few bugs that are marked to be solved. The weekend of March 30th / April 1st we want to do another release though I suspect it takes another month to get rid of all the bugs. After that we intend to follow up quickly with a beta or even a Release Candidate. Nonetheless is phpDocumentor2 now in a more than usable state; thus don’t let the alpha tag hold you back
3. Between the last DocBlox release and the first phpDocumentor v2 have a few command line options been added such as –ignore-symlinks, –hidden and –ignore-tags, several bugs have been solved and a completely new responsive template (that one took quite some time to create).
4. Well, the DocBlox project itself is discontinued and the name will be reserved. The website and pear repositories will continue to be online for some time; though eventually will the website redirect to the phpDocumentor website or be repurposed (no plans on that yet).
Let me know if you have any other questions, happy to help!
March 20th, 2012 @ 8:58 am
Great news! It’s good to see the community building one great system for standardized documentation!
One question seems unanswered in the posts surrounding phpdocumentor2 / docblox: what’s the upgrade path going from docblox to phpdocumentor? Is it as easy as replacing the executable? Or is there more to it?
(as a TL;DR lover: some type of simple howto / blog would be excellent)
March 20th, 2012 @ 1:47 pm
Hi again. Thanks for answering my questions yesterday
Another couple of questions I thought of:
For phpDoc v1 users, how much of a drop-in replacement is v2? I know DocBlox was designed to have a compatible interface, but is there any functionality from phpDoc v1 that is not yet implemented in v2? Or anything that works differently between the two?
Also, is phpDoc v1 still available? If so, where is it? (I can’t see any mention of it on the site).
Thanks again!
SimonC.
March 20th, 2012 @ 1:56 pm
phpdoc v1 is still available via PEAR as it always been. The documentation is also still available via manual.phpdoc.org; though this is being slowly replaced by phpdocumentor2′s documentation at http://phpdoc.org/docs.
The upgrade path from DocBlox to phpDocumentor 2 is a matter of swapping the executable names and the upgrade path of phpDocumentor 1 to phpDocumentor 2 is _mostly_ a matter of expanding the shortform commandline arguments to their full counterpart.
Tutorials and a few tags are not supported yet but that is being worked on.
March 26th, 2012 @ 7:12 pm
The “Fork me on GitHub” link is broken on this page.
Also, I kept going to http://github.com/mvriel/docblox and getting an error page, and only today got around to coming to this site to see what was wrong. Perhaps you can put a dummy site back up there.
Also, my git scripts to update broke, but I guess that was tobe expected.
March 29th, 2012 @ 2:00 am
[...] tout les deux aussi efficace l’un que l’autre ont décidé, il y a deux semaines, de fusionner pour créer PhpDocumentor 2 dont voici le nouveau template par défaut : Démo. Au programme [...]
April 1st, 2012 @ 7:05 pm
[...] probably heard about this, the popular documentation tools phpDocumentor and DocBlox have merged! Phing supports the new phpDocumentor releases by adding a phpdoc2 [...]
April 27th, 2012 @ 5:34 pm
I’m sorry about the inconvenience. When executing the merge we had to choose between several options that each would have had a downside. We chose to rename the organisation and repositories to make sure that all watchers and followers were informed and received notification. The downside is that those URLs are now unreachable and/or do not redirect.
Thanks for the tip on the dummy site at my personal account; that should be no problem for the time being.