Re: [zeta-dev] Website #2
Hi Christian, On 10/06/2010 12:28 PM, Christian Grobmeier wrote: > on the website: > http://incubator.apache.org/zetacomponents/documentation/install.html > its stating you are using BSD license. This should be changed. those are fixed now. > Btw - do you prefer Jira bugs for my website comments? Yes, that would be good. Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
[zeta-dev] Website #2
Hello, on the website: http://incubator.apache.org/zetacomponents/documentation/install.html its stating you are using BSD license. This should be changed. Btw - do you prefer Jira bugs for my website comments? Cheers christian
Re: [zeta-dev] Website online, help appreciated
> "Apache Zeta Components is an effort undergoing incubation at The > Apache Software Foundation (ASF), sponsored by eZ Systems". > "Apache Zeta Components originally were developed by eZ Systems under > the name "eZ Components" and was generously sponsored to the Apache > Software Foundation for further development." > For me it's sounding wrong, the code was *donated*, the incubation is > not sponsored, or perhaps I'm missing something there. +1 "donated" sounds more fitting to me too. But I am not native a native speaker, as you already might have noticed :-)
Re: [zeta-dev] Website online, help appreciated
Hi ! On the main page you have two occurrence of "sponsored by eZ Systems". "Apache Zeta Components is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by eZ Systems". "Apache Zeta Components originally were developed by eZ Systems under the name "eZ Components" and was generously sponsored to the Apache Software Foundation for further development." For me it's sounding wrong, the code was *donated*, the incubation is not sponsored, or perhaps I'm missing something there. My 2 cents. Julien On Sun, Aug 29, 2010 at 12:08 PM, Andreas Schamberger wrote: > Hi, > > I just browsed through the website and noticed that all internal links are > broken besides the ones in the navigation bar. E.g. > "/documentation/overview.html". Here the top level zetacomponents directory > is missing in the path. > > Btw. is it possible to redirect the whole ezcomponents.org to the new > website? Maybe to a special info page that ezc is now zeta. And is it also > possible to put the old issue tracker in read only mode with a small notice? > > Regards, > Andreas > > Am 06.08.2010 09:24, schrieb Tobias Schlitt: >> >> -BEGIN PGP SIGNED MESSAGE- >> Hash: SHA1 >> >> Hi all, >> >> as you probably noted, our website is online in a first version. The >> official address is >> >> http://incubator.apache.org/zetacomponents >> >> In addition to that, I redirect >> >> http://zeta-components.net >> http://zeta-components.org >> http://zetacomponents.org >> >> to this address. Kore owns >> >> http://zetacomponents.org >> >> in addition, but this one is not redirecting, yet, since he is on >> vacation. >> >> If we become a top level project somewhen, I'd suggest one of these to >> be transfered to the ASF to avoid the need redirecting. >> >> I wonder, which of these domains we want to have as the "official" one? >> I'd prefer zeta-components.org or zetacomponents.org. >> >> What do you think? >> >> The website is by now mainly a migration of the old eZ Components >> content. However, there are still lots of old references in it, e.g. to >> the eZ SVN and stuff. I'd appreciate help in checking all the sites for >> such stuff. Patches are very welcome. :) >> >> You can find the source in our SVN: >> >> https://svn.apache.org/repos/asf/incubator/zetacomponents/website >> >> Thanks in advance to every helping hand, >> have a nice weekend, >> Toby >> - -- >> Tobias Schlitt http://schlitt.info GPG Key: 0xC462BC14 >> Want to hire me? Need quality assurance? http://qafoo.com >> eZ Components are Zeta Components now! http://bit.ly/9S7zbn >> -BEGIN PGP SIGNATURE- >> Version: GnuPG v1.4.10 (GNU/Linux) >> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ >> >> iEYEARECAAYFAkxbuJAACgkQ5bO3TcRivBT9RACeNDGmhfQKPqqrOg6S1tCtU9k8 >> V9IAnRG/9nY0QOIUVG0GYRRRO8fTr4M6 >> =cBck >> -END PGP SIGNATURE- > >
Re: [zeta-dev] Website online, help appreciated
Hi, I just browsed through the website and noticed that all internal links are broken besides the ones in the navigation bar. E.g. "/documentation/overview.html". Here the top level zetacomponents directory is missing in the path. Btw. is it possible to redirect the whole ezcomponents.org to the new website? Maybe to a special info page that ezc is now zeta. And is it also possible to put the old issue tracker in read only mode with a small notice? Regards, Andreas Am 06.08.2010 09:24, schrieb Tobias Schlitt: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, as you probably noted, our website is online in a first version. The official address is http://incubator.apache.org/zetacomponents In addition to that, I redirect http://zeta-components.net http://zeta-components.org http://zetacomponents.org to this address. Kore owns http://zetacomponents.org in addition, but this one is not redirecting, yet, since he is on vacation. If we become a top level project somewhen, I'd suggest one of these to be transfered to the ASF to avoid the need redirecting. I wonder, which of these domains we want to have as the "official" one? I'd prefer zeta-components.org or zetacomponents.org. What do you think? The website is by now mainly a migration of the old eZ Components content. However, there are still lots of old references in it, e.g. to the eZ SVN and stuff. I'd appreciate help in checking all the sites for such stuff. Patches are very welcome. :) You can find the source in our SVN: https://svn.apache.org/repos/asf/incubator/zetacomponents/website Thanks in advance to every helping hand, have a nice weekend, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxbuJAACgkQ5bO3TcRivBT9RACeNDGmhfQKPqqrOg6S1tCtU9k8 V9IAnRG/9nY0QOIUVG0GYRRRO8fTr4M6 =cBck -END PGP SIGNATURE-
Re: [zeta-dev] Website online, help appreciated
2010/8/10 Tobias Schlitt > -BEGIN PGP SIGNED MESSAGE- > Hash: SHA1 > > On 08/10/2010 12:05 PM, Sebastian Bergmann wrote: > > Am 10.08.2010 12:01, schrieb Tobias Schlitt: > >> Having diffs of generated HTML on the list feels quite senseless to me. > >> The diff of the content source is much more important. > > > > I made a small change to support.txt and ran "make website". This > > resulted in thousands of changed files. This made no sense to me and > > I wanted to use "svn diff" to figure out whether the changes in the > > file generated from support.txt were correct. This did not work, hence > > my initial mail. > > I definitely see your point here. The question should be if we find a > way to ship around this issue of not being able to make a local diff > without having the commit mailinglist spammed on every doc update. > > Anyone a creative idea? > > Regards, > Toby > Is it not possible to create a filter, so that not all directorys/files are forwarded to the mailinglist?
Re: [zeta-dev] Website online, help appreciated
Am 10.08.2010 13:02, schrieb Derick Rethans: > Yes, don't mark them as binary. +1 > "make website" shouldn't touch any files that aren't actually going to > be changed +1 -- Sebastian BergmannCo-Founder and Principal Consultant http://sebastian-bergmann.de/ http://thePHP.cc/ signature.asc Description: OpenPGP digital signature
Re: [zeta-dev] Website online, help appreciated
On Tue, 10 Aug 2010, Tobias Schlitt wrote: > On 08/10/2010 12:05 PM, Sebastian Bergmann wrote: > > Am 10.08.2010 12:01, schrieb Tobias Schlitt: > >> Having diffs of generated HTML on the list feels quite senseless to me. > >> The diff of the content source is much more important. > > > > I made a small change to support.txt and ran "make website". This > > resulted in thousands of changed files. This made no sense to me and > > I wanted to use "svn diff" to figure out whether the changes in the > > file generated from support.txt were correct. This did not work, hence > > my initial mail. > > I definitely see your point here. The question should be if we find a > way to ship around this issue of not being able to make a local diff > without having the commit mailinglist spammed on every doc update. > > Anyone a creative idea? Yes, don't mark them as binary. Mails are easy to delete. Alternatively, "make website" shouldn't touch any files that aren't actually going to be changed... Derick -- http://derickrethans.nl | http://xdebug.org Like Xdebug? Consider a donation: http://xdebug.org/donate.php twitter: @derickr and @xdebug
Re: [zeta-dev] Website online, help appreciated
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 08/10/2010 12:05 PM, Sebastian Bergmann wrote: > Am 10.08.2010 12:01, schrieb Tobias Schlitt: >> Having diffs of generated HTML on the list feels quite senseless to me. >> The diff of the content source is much more important. > > I made a small change to support.txt and ran "make website". This > resulted in thousands of changed files. This made no sense to me and > I wanted to use "svn diff" to figure out whether the changes in the > file generated from support.txt were correct. This did not work, hence > my initial mail. I definitely see your point here. The question should be if we find a way to ship around this issue of not being able to make a local diff without having the commit mailinglist spammed on every doc update. Anyone a creative idea? Regards, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxhJ4IACgkQ5bO3TcRivBQGMQCfThQKwEB6AwK8vxS2hI5xUL5N RY0AoJdW4ud3SGvlP+BhxLJfXTG5K/Fa =N++r -END PGP SIGNATURE-
Re: [zeta-dev] Website online, help appreciated
Am 10.08.2010 12:01, schrieb Tobias Schlitt: > Having diffs of generated HTML on the list feels quite senseless to me. > The diff of the content source is much more important. I made a small change to support.txt and ran "make website". This resulted in thousands of changed files. This made no sense to me and I wanted to use "svn diff" to figure out whether the changes in the file generated from support.txt were correct. This did not work, hence my initial mail. -- Sebastian BergmannCo-Founder and Principal Consultant http://sebastian-bergmann.de/ http://thePHP.cc/ signature.asc Description: OpenPGP digital signature
Re: [zeta-dev] Website online, help appreciated
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi, On 08/10/2010 11:43 AM, Derick Rethans wrote: > On Mon, 9 Aug 2010, Tobias Schlitt wrote: >> On 08/06/2010 03:15 PM, Sebastian Bergmann wrote: >>> Am 06.08.2010 09:24, schrieb Tobias Schlitt: You can find the source in our SVN: https://svn.apache.org/repos/asf/incubator/zetacomponents/website >>> Is there a reason why the generated HTML files are stored as binary in >>> Subversion >>> >>>Index: support.html >>>=== >>>Cannot display: file marked as a binary type. >>>svn:mime-type = application/octet-stream >>> >>> This makes diff-before-commit impossible. >> The reason here is, that committing a full doc update would otherwise >> result in a huge lot of commit mails. > They are not binary files, so they shouldn't be marked as binary. I don't see the point here. We already used such binary marking for other huge portions of plain text, which tend to change now and then and pollute the commit mailinglist with a large amount of mails. So why shouldn't we do it here, too? Having diffs of generated HTML on the list feels quite senseless to me. The diff of the content source is much more important. Regards, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxhI28ACgkQ5bO3TcRivBTBbwCeP2Bwl60iPSyxcpfvQRHsKKwy ZUMAnA+tsw50cJj7fXfISKfmKJ+u2WZU =aDvh -END PGP SIGNATURE-
Re: [zeta-dev] Website online, help appreciated
On Mon, 9 Aug 2010, Tobias Schlitt wrote: > On 08/06/2010 03:15 PM, Sebastian Bergmann wrote: > > Am 06.08.2010 09:24, schrieb Tobias Schlitt: > >> You can find the source in our SVN: > >> > >> https://svn.apache.org/repos/asf/incubator/zetacomponents/website > > > Is there a reason why the generated HTML files are stored as binary in > > Subversion > > > >Index: support.html > >=== > >Cannot display: file marked as a binary type. > >svn:mime-type = application/octet-stream > > > > This makes diff-before-commit impossible. > > The reason here is, that committing a full doc update would otherwise > result in a huge lot of commit mails. They are not binary files, so they shouldn't be marked as binary. Derick -- http://derickrethans.nl | http://xdebug.org Like Xdebug? Consider a donation: http://xdebug.org/donate.php twitter: @derickr and @xdebug
Re: [zeta-dev] Website online, help appreciated
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 08/06/2010 03:15 PM, Sebastian Bergmann wrote: > Am 06.08.2010 09:24, schrieb Tobias Schlitt: >> You can find the source in our SVN: >> >> https://svn.apache.org/repos/asf/incubator/zetacomponents/website > Is there a reason why the generated HTML files are stored as binary in > Subversion > >Index: support.html >=== >Cannot display: file marked as a binary type. >svn:mime-type = application/octet-stream > > This makes diff-before-commit impossible. The reason here is, that committing a full doc update would otherwise result in a huge lot of commit mails. It could be an idea to mark only the phpDoc content binary, the diff is not that important there, I think. Would that be in your sense? Regards, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEUEARECAAYFAkxgYOYACgkQ5bO3TcRivBTYXgCeJsDEJSa1YWf7Op+EVVDJBIvR z68AlRznSlgx9mkyNejoYmbhFiv0xxQ= =p3nN -END PGP SIGNATURE-
Re: [zeta-dev] Website online, help appreciated
Hi Tobias, Please find attached a few patches that fixes legacy eZ stuff in the component's tutorial. There are stuff that are not fixed yet, like http://ez.no/doc/components/view/latest/(file)/ as I am not sure which new URL to use for these ones. Each modification in the tarball is provided as a separate patch so you can control what you want or not and these patches are (normally) not mutually exclusive. Cheers, -- Jérôme Renard http://39web.fr | http://jrenard.info zcfixes.tar.gz Description: GNU Zip compressed data
Re: [zeta-dev] Website online, help appreciated
Am 06.08.2010 09:24, schrieb Tobias Schlitt: > You can find the source in our SVN: > > https://svn.apache.org/repos/asf/incubator/zetacomponents/website Is there a reason why the generated HTML files are stored as binary in Subversion Index: support.html === Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream This makes diff-before-commit impossible. -- Sebastian BergmannCo-Founder and Principal Consultant http://sebastian-bergmann.de/ http://thePHP.cc/ signature.asc Description: OpenPGP digital signature
Re: [zeta-dev] Website online, help appreciated
Hi Tobias, On Fri, Aug 6, 2010 at 9:24 AM, Tobias Schlitt wrote: > [...] > > If we become a top level project somewhen, I'd suggest one of these to > be transfered to the ASF to avoid the need redirecting. > > I wonder, which of these domains we want to have as the "official" one? > I'd prefer zeta-components.org or zetacomponents.org. > http://zetacomponents.org definitely. > What do you think? > > The website is by now mainly a migration of the old eZ Components > content. However, there are still lots of old references in it, e.g. to > the eZ SVN and stuff. I'd appreciate help in checking all the sites for > such stuff. Patches are very welcome. :) > > You can find the source in our SVN: > > https://svn.apache.org/repos/asf/incubator/zetacomponents/website > I'll if I have spare time today to help. Cheers, -- Jérôme Renard http://39web.fr | http://jrenard.info
[zeta-dev] Website online, help appreciated
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, as you probably noted, our website is online in a first version. The official address is http://incubator.apache.org/zetacomponents In addition to that, I redirect http://zeta-components.net http://zeta-components.org http://zetacomponents.org to this address. Kore owns http://zetacomponents.org in addition, but this one is not redirecting, yet, since he is on vacation. If we become a top level project somewhen, I'd suggest one of these to be transfered to the ASF to avoid the need redirecting. I wonder, which of these domains we want to have as the "official" one? I'd prefer zeta-components.org or zetacomponents.org. What do you think? The website is by now mainly a migration of the old eZ Components content. However, there are still lots of old references in it, e.g. to the eZ SVN and stuff. I'd appreciate help in checking all the sites for such stuff. Patches are very welcome. :) You can find the source in our SVN: https://svn.apache.org/repos/asf/incubator/zetacomponents/website Thanks in advance to every helping hand, have a nice weekend, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxbuJAACgkQ5bO3TcRivBT9RACeNDGmhfQKPqqrOg6S1tCtU9k8 V9IAnRG/9nY0QOIUVG0GYRRRO8fTr4M6 =cBck -END PGP SIGNATURE-
Re: [zeta-dev] Website
Sum up: Sphynx cool with RST or Python. Sphynx bad with PHP API Documentation. Ok. 2010/7/30 Jerome Renard > Kore, > > On Fri, Jul 30, 2010 at 1:34 PM, Kore Nordmann >wrote: > > > Hi Jerome, > > > > On Fri, 2010-07-30 at 13:26 +0200, Jerome Renard wrote: > > > > > You can check it out here : > > > > > > - http://jrenard.info/utils/zetacomponentsdoc-sphinx/ > > > > > > There are multilple versions of the doc, the contents is the same I > > > just used different templates so you can see different results. > > > > That looks interesting, but the rendering of the RST stuff is done by > > WCV and that would basically require us replacing the whole website > > engine. > > > > H ok, I see the problem now. > > > > > > I saw that Sphinx also uses docutils + pygments - which I could try to > > use, too, for highlighting the source code. (Docutils are used anyways > > for now) > > > > The major issue with the doc generation are not the tutorials, but the > > API documentation - and afaik Sphinx cannot really help here. > > > > Yes for that part, Sphinx does not really help. > > > > > > The source code highlighting in the generated HTML inside WCV is only a > > minor issue (XPath + php_highlight_source + regexp to link class names) > > and already implemented by Derick for the "old" website. > > > > Ok. > > > > > > The tutorials rendered by Sphinx look really nice, though. We might want > > to borrow some styling ideas from there for the tutorials ;). > > > > He he, feel free to take anything you want ;) > > -- > Jérôme Renard > http://39web.fr | http://jrenard.info >
Re: [zeta-dev] Website
Kore, On Fri, Jul 30, 2010 at 1:34 PM, Kore Nordmann wrote: > Hi Jerome, > > On Fri, 2010-07-30 at 13:26 +0200, Jerome Renard wrote: > > > You can check it out here : > > > > - http://jrenard.info/utils/zetacomponentsdoc-sphinx/ > > > > There are multilple versions of the doc, the contents is the same I > > just used different templates so you can see different results. > > That looks interesting, but the rendering of the RST stuff is done by > WCV and that would basically require us replacing the whole website > engine. > H ok, I see the problem now. > > I saw that Sphinx also uses docutils + pygments - which I could try to > use, too, for highlighting the source code. (Docutils are used anyways > for now) > > The major issue with the doc generation are not the tutorials, but the > API documentation - and afaik Sphinx cannot really help here. > Yes for that part, Sphinx does not really help. > > The source code highlighting in the generated HTML inside WCV is only a > minor issue (XPath + php_highlight_source + regexp to link class names) > and already implemented by Derick for the "old" website. > Ok. > > The tutorials rendered by Sphinx look really nice, though. We might want > to borrow some styling ideas from there for the tutorials ;). > He he, feel free to take anything you want ;) -- Jérôme Renard http://39web.fr | http://jrenard.info
Re: [zeta-dev] Website
Hi Jerome, On Fri, 2010-07-30 at 13:26 +0200, Jerome Renard wrote: > You can check it out here : > > - http://jrenard.info/utils/zetacomponentsdoc-sphinx/ > > There are multilple versions of the doc, the contents is the same I > just used different templates so you can see different results. That looks interesting, but the rendering of the RST stuff is done by WCV and that would basically require us replacing the whole website engine. I saw that Sphinx also uses docutils + pygments - which I could try to use, too, for highlighting the source code. (Docutils are used anyways for now) The major issue with the doc generation are not the tutorials, but the API documentation - and afaik Sphinx cannot really help here. The source code highlighting in the generated HTML inside WCV is only a minor issue (XPath + php_highlight_source + regexp to link class names) and already implemented by Derick for the "old" website. The tutorials rendered by Sphinx look really nice, though. We might want to borrow some styling ideas from there for the tutorials ;). -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ - Hire me: http://qafoo.com/ signature.asc Description: This is a digitally signed message part
Re: [zeta-dev] Website
All, On Fri, Jul 30, 2010 at 11:50 AM, Jerome Renard wrote: > All, > > On Fri, Jul 30, 2010 at 10:41 AM, Jerome Renard > wrote: > >> Tobias, >> >> On Fri, Jul 30, 2010 at 10:37 AM, Tobias Schlitt wrote: >> >>> -BEGIN PGP SIGNED MESSAGE- >>> Hash: SHA1 >>> >>> [...] >>> >>> >>> So using Sphinx in favor of plain docutils yields you only some >>> enhancements regarding the code markup, if I get that correct? >>> >> >> Yep, I am actually working on writing a system that could at least prepare >> the >> whole directory structure automatically for Sphinx. I'll keep you posted >> :) >> >> > Done :) > > You can check it out here : > > - http://jrenard.info/utils/zetacomponentsdoc-sphinx/ > > There are multilple versions of the doc, the contents is the same I just > used different templates so you can see different results. If you want to generate the doc by yourself, this is now possible. You first need to install sphinx : easy_install -U Sphinx Download the attached tarball, edit ./gensphinx.sh and modify the BASEDIR variable according to your SVN repository. Once done just run ./gensphinx.sh && make html You should get the generated doc in the build/html directory. There are a few warnings during the generation process this is because some Components from trunk/ do not have a tutorial.txt file yet so this is not a major issue :) Hope that helps, -- Jérôme Renard http://39web.fr | http://jrenard.info sphinxdoc.tar.gz Description: GNU Zip compressed data
Re: [zeta-dev] Website
All, On Fri, Jul 30, 2010 at 10:41 AM, Jerome Renard wrote: > Tobias, > > On Fri, Jul 30, 2010 at 10:37 AM, Tobias Schlitt wrote: > >> -BEGIN PGP SIGNED MESSAGE- >> Hash: SHA1 >> >> [...] >> >> So using Sphinx in favor of plain docutils yields you only some >> enhancements regarding the code markup, if I get that correct? >> > > Yep, I am actually working on writing a system that could at least prepare > the > whole directory structure automatically for Sphinx. I'll keep you posted :) > > Done :) You can check it out here : - http://jrenard.info/utils/zetacomponentsdoc-sphinx/ There are multilple versions of the doc, the contents is the same I just used different templates so you can see different results. Cheers, -- Jérôme Renard http://39web.fr | http://jrenard.info
Re: [zeta-dev] Website
Tobias, On Fri, Jul 30, 2010 at 10:37 AM, Tobias Schlitt wrote: > -BEGIN PGP SIGNED MESSAGE- > Hash: SHA1 > > Hi guys, > > On 07/30/2010 10:05 AM, Jerome Renard wrote: > > On Fri, Jul 30, 2010 at 9:05 AM, Kore Nordmann >wrote: > >> On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote: > > >>> Else, I ve looked to Sphynx, is it only for Python ? > > >> Looked like it to me … Jerome? :) > > > I am currently writing a book using Sphinx and I also deliver my customer > > documentation > > using SPhinx as well. Basically, Sphinx uses RST + some cool stuff around > it > > so migrating > > ZC tutorials from plain RST to Sphinx is a matter of around 2 hours of > work, > > just to add the correct > > Sphinx instructions to get syntax coloring for example. > > > > However Sphinx is initially built for Python project which means it know > > absolutely nothing about > > PHP Doc, but coupling the documentation generated by Sphinx and the PHP > Doc > > should not be that > > difficult actually. > > So using Sphinx in favor of plain docutils yields you only some > enhancements regarding the code markup, if I get that correct? > Yep, I am actually working on writing a system that could at least prepare the whole directory structure automatically for Sphinx. I'll keep you posted :) Cheers, -- Jérôme Renard http://39web.fr | http://jrenard.info
Re: [zeta-dev] Website
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi guys, On 07/30/2010 10:05 AM, Jerome Renard wrote: > On Fri, Jul 30, 2010 at 9:05 AM, Kore Nordmann wrote: >> On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote: >>> Else, I ve looked to Sphynx, is it only for Python ? >> Looked like it to me … Jerome? :) > I am currently writing a book using Sphinx and I also deliver my customer > documentation > using SPhinx as well. Basically, Sphinx uses RST + some cool stuff around it > so migrating > ZC tutorials from plain RST to Sphinx is a matter of around 2 hours of work, > just to add the correct > Sphinx instructions to get syntax coloring for example. > > However Sphinx is initially built for Python project which means it know > absolutely nothing about > PHP Doc, but coupling the documentation generated by Sphinx and the PHP Doc > should not be that > difficult actually. So using Sphinx in favor of plain docutils yields you only some enhancements regarding the code markup, if I get that correct? Regards, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxSj1kACgkQ5bO3TcRivBSfagCgu/75SQBpEWHqlg4Iwp8WnOLv TPsAnjcpDMy1p7f7Vt4XlmnXADa0LGCL =03B3 -END PGP SIGNATURE-
Re: [zeta-dev] Website
Hi there, On Fri, Jul 30, 2010 at 9:05 AM, Kore Nordmann wrote: > Hi Maxime, > > On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote: > > Good job ! > > Thanks. > > > Is there a thing we can do about the copy paste that occurred on PHP > > code ? When you select the code and past it, each line are prefixed by > > # or number. It could be an improvement. > > Those are the code snippets generated by PHPDoc, which uses . I will > commit the full custom code used to generate the API docs to the SVN, > once it has been seconded by the ML. > > The PHPDocumentor Code is, let's say, not optimal. It combines Smarty > templates with PHP code generating HTML code - not that easy to > customize (beside generating docs and website takes something between 10 > to 300 minutes depending on various factors). > > Feel free to fix that, though. :) > > > Else, I ve looked to Sphynx, is it only for Python ? > > Looked like it to me … Jerome? :) > I am currently writing a book using Sphinx and I also deliver my customer documentation using SPhinx as well. Basically, Sphinx uses RST + some cool stuff around it so migrating ZC tutorials from plain RST to Sphinx is a matter of around 2 hours of work, just to add the correct Sphinx instructions to get syntax coloring for example. However Sphinx is initially built for Python project which means it know absolutely nothing about PHP Doc, but coupling the documentation generated by Sphinx and the PHP Doc should not be that difficult actually. Hope that helps :) -- Jérôme Renard http://39web.fr | http://jrenard.info
Re: [zeta-dev] Website
Symfony2 has just yesterday moved all their docs to ReST + Sphinx Doc Generation, so it is also working for PHP projects and might be a solution to look into. On Fri, 30 Jul 2010 09:05:07 +0200, Kore Nordmann wrote: > Hi Maxime, > > On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote: >> Good job ! > > Thanks. > >> Is there a thing we can do about the copy paste that occurred on PHP >> code ? When you select the code and past it, each line are prefixed by >> # or number. It could be an improvement. > > Those are the code snippets generated by PHPDoc, which uses . I will > commit the full custom code used to generate the API docs to the SVN, > once it has been seconded by the ML. > > The PHPDocumentor Code is, let's say, not optimal. It combines Smarty > templates with PHP code generating HTML code - not that easy to > customize (beside generating docs and website takes something between 10 > to 300 minutes depending on various factors). > > Feel free to fix that, though. :) > >> Else, I ve looked to Sphynx, is it only for Python ? > > Looked like it to me … Jerome? :) > > Kind regards, > Kore
Re: [zeta-dev] Website
Hi Maxime, On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote: > Good job ! Thanks. > Is there a thing we can do about the copy paste that occurred on PHP > code ? When you select the code and past it, each line are prefixed by > # or number. It could be an improvement. Those are the code snippets generated by PHPDoc, which uses . I will commit the full custom code used to generate the API docs to the SVN, once it has been seconded by the ML. The PHPDocumentor Code is, let's say, not optimal. It combines Smarty templates with PHP code generating HTML code - not that easy to customize (beside generating docs and website takes something between 10 to 300 minutes depending on various factors). Feel free to fix that, though. :) > Else, I ve looked to Sphynx, is it only for Python ? Looked like it to me … Jerome? :) Kind regards, Kore -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ signature.asc Description: This is a digitally signed message part
Re: [zeta-dev] Website
On Thu, 2010-07-29 at 23:09 +0200, Christian Grobmeier wrote: [..] > Here is some more information on a good podling sitep: > http://incubator.apache.org/guides/sites.html Thanks for the pointer. I incorporated the suggested and required changes from there. > It also describes the location the zeta site. I have prepared the > folder for it already. > > I also would like to mention, that Zeta Components is currently not a > full Apache project, its in incubation phase. I think its worth > mentioning this state on the website. Usually podlings write something > like:"Apache Zeta Components is currently underunning incubation..." > or similar. This makes clear that things change and some things like > copyright or licensing stuff need to be sorted out. > > Additionally some podlings (or those I know) add the Incubation logo > somewhere: > http://incubator.apache.org/images/apache-incubator-logo.png Added both to the start (news) page. :) (Will be online soonish) One open question left to me is the "incubation status file", which is intended to be available at http://incubator.apache.org/projects/podlingname.html - will you take care of that? > Just out of curiosity - what tool did you use for generating the site? http://web-content-viewer.org - it is the software some of us are also using for our blogs. But in this case I wrapped it in a make file to make it transparent to the users. The software never reached something one would want to call "alpha" - it is not at all ready for "users" :) Kind regards, Kore -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ signature.asc Description: This is a digitally signed message part
Re: [zeta-dev] Website
Hi Manuel, On Thu, 2010-07-29 at 20:36 +0200, Manuel Pichler wrote: > Hi Kore, > > the website looks really nice and shiny, but I have found one little > content issue. The main headline and most of the paragraphs on > "Documentation > Installation"[1] still still contain the text "eZ > Components" instead of "Zeta Components". Thanks for the pointer. I replaced in the title and added a note to the document. Especially this document still requires quite a bit refactoring, since it metions "eZ Components" and "eZ Systems" quite often… Kind regards, Kore -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ signature.asc Description: This is a digitally signed message part
Re: [zeta-dev] Website
Good job ! Is there a thing we can do about the copy paste that occurred on PHP code ? When you select the code and past it, each line are prefixed by # or number. It could be an improvement. Else, I ve looked to Sphynx, is it only for Python ?
Re: [zeta-dev] Website
Hello, > The website is available for preview here: > http://zeta:z...@zeta-components.org/news.html wow, it looks fantastic! > Afaik it considered best practice to commit the HTML to the project > repository and the website will then be deployed to the Apache HTTP > mirrors. > I would prefer to commit the whole repository contents to "/website", so > that everybody can easily regenerate the website. (Makefile and docs are > included). Do you second this? Thats true. The complete generated website needs to be checked in. In case of an error, a simple svn co should be able to restore it. The logging project called their folder "/site", but your proposal is fine anyway. Here is some more information on a good podling sitep: http://incubator.apache.org/guides/sites.html It also describes the location the zeta site. I have prepared the folder for it already. I also would like to mention, that Zeta Components is currently not a full Apache project, its in incubation phase. I think its worth mentioning this state on the website. Usually podlings write something like:"Apache Zeta Components is currently underunning incubation..." or similar. This makes clear that things change and some things like copyright or licensing stuff need to be sorted out. Additionally some podlings (or those I know) add the Incubation logo somewhere: http://incubator.apache.org/images/apache-incubator-logo.png I don't think its necessary, but I like it because of mentioned reasons. Also its a good ad for the Incubator project of course :-) Just out of curiosity - what tool did you use for generating the site? Best regards, Christian
Re: [zeta-dev] Website
Hi Kore, the website looks really nice and shiny, but I have found one little content issue. The main headline and most of the paragraphs on "Documentation > Installation"[1] still still contain the text "eZ Components" instead of "Zeta Components". Greetings Manuel [1] http://zeta-components.org/documentation/install.html On Thu, 2010-07-29 at 13:06 +0200, Kore Nordmann wrote: > Hi, > > As you know I was working on the new website for the zeta components. I > just regenerated it - the API documentation now contains proper links to > the fisheye source code browser. > > The website is available for preview here: > http://zeta:z...@zeta-components.org/news.html > > The repository containing the website and the generation scripts is > available at: > svn://svn.qafoo.com/zeta-website > > The full Checkout is about 256MB and contains about 26k files - the API > documentation generates quite some HTML files (and for now it is only > generated for trunk/). > > Afaik it considered best practice to commit the HTML to the project > repository and the website will then be deployed to the Apache HTTP > mirrors. > > I would prefer to commit the whole repository contents to "/website", so > that everybody can easily regenerate the website. (Makefile and docs are > included). Do you second this? > > This would mean, that "/website/htdocs" would then be mirrored to the > Apache web servers (which is, without the .svn dirs, around 50MB). > > Kind regards, > Kore >
Re: [zeta-dev] Website
Kore, On Thu, Jul 29, 2010 at 1:29 PM, Kore Nordmann wrote: > On Thu, 2010-07-29 at 13:20 +0200, Jerome Renard wrote: > > - Is that normal that some methods do not point to the API doc ? For > example > > if you take this page : > > > http://zeta-components.org/documentation/trunk/Base/tutorial.html#file-operationsthe > > string "ezcBaseFile::findRecursive()" from "This example shows how to > > use the ezcBaseFile::findRecursive() method:" does not point anywhere, is > > that normal ? > > Yes, for now. There are no links and source code highlighting in the > tutorial. It is "comlicated" to setup natively with python-docutils and > the post-processing of the generated HTML files is just not implemented > yet. I will add that at some point. > > Do you think that migrating to Sphinx [1] would be relevant ? Just asking. > > - Do you think you can add some syntax coloring to the PHP code so it is > > easier to read ? > > The source highlighting in the API docs is just a matter of some CSS > rules - should be easy to add. :) > Cool :) > > For the tutorials: See above. > > > Other than that, the website looks good, I especially love the new logo, > who > > created it ? > > That would be me. Thanks. :-) > Kudos to you then :) 1. http://sphinx.pocoo.org/ -- Jérôme Renard http://39web.fr | http://jrenard.info
Re: [zeta-dev] Website
On Thu, 2010-07-29 at 13:20 +0200, Jerome Renard wrote: > - Is that normal that some methods do not point to the API doc ? For example > if you take this page : > http://zeta-components.org/documentation/trunk/Base/tutorial.html#file-operations > the > string "ezcBaseFile::findRecursive()" from "This example shows how to > use the ezcBaseFile::findRecursive() method:" does not point anywhere, is > that normal ? Yes, for now. There are no links and source code highlighting in the tutorial. It is "comlicated" to setup natively with python-docutils and the post-processing of the generated HTML files is just not implemented yet. I will add that at some point. > - Do you think you can add some syntax coloring to the PHP code so it is > easier to read ? The source highlighting in the API docs is just a matter of some CSS rules - should be easy to add. :) For the tutorials: See above. > Other than that, the website looks good, I especially love the new logo, who > created it ? That would be me. Thanks. :-) Kind regards, Kore -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ signature.asc Description: This is a digitally signed message part
Re: [zeta-dev] Website
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi, On 07/29/2010 01:06 PM, Kore Nordmann wrote: > The website is available for preview here: > http://zeta:z...@zeta-components.org/news.html I love the new design. The website looks really cool. I think all essentials are in place, so that we can go online with a first version and migrate the website source to Zeta SVN soonish. All minor adjustments (e.g. CSS, code links in tutorials and stuff) can then be performed there, so everyone can take part in it. Nice work! Cheers, Toby - -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxRZZcACgkQ5bO3TcRivBRH6wCfQP6LfyH/UO6MT+ioBHynOzqe L+IAniP2cUZkp9MGQ9Yfv8TYJ7jy8Dp6 =AZhb -END PGP SIGNATURE-
Re: [zeta-dev] Website
Hi Kore, On Thu, Jul 29, 2010 at 1:06 PM, Kore Nordmann wrote: > Hi, > > As you know I was working on the new website for the zeta components. I > just regenerated it - the API documentation now contains proper links to > the fisheye source code browser. > > The website is available for preview here: >http://zeta:z...@zeta-components.org/news.html > > The repository containing the website and the generation scripts is > available at: >svn://svn.qafoo.com/zeta-website > > The full Checkout is about 256MB and contains about 26k files - the API > documentation generates quite some HTML files (and for now it is only > generated for trunk/). > > I just had a look and I have 2 questions : - Is that normal that some methods do not point to the API doc ? For example if you take this page : http://zeta-components.org/documentation/trunk/Base/tutorial.html#file-operationsthe string "ezcBaseFile::findRecursive()" from "This example shows how to use the ezcBaseFile::findRecursive() method:" does not point anywhere, is that normal ? - Do you think you can add some syntax coloring to the PHP code so it is easier to read ? Other than that, the website looks good, I especially love the new logo, who created it ? Cheers :) -- Jérôme Renard http://39web.fr | http://jrenard.info
[zeta-dev] Website
Hi, As you know I was working on the new website for the zeta components. I just regenerated it - the API documentation now contains proper links to the fisheye source code browser. The website is available for preview here: http://zeta:z...@zeta-components.org/news.html The repository containing the website and the generation scripts is available at: svn://svn.qafoo.com/zeta-website The full Checkout is about 256MB and contains about 26k files - the API documentation generates quite some HTML files (and for now it is only generated for trunk/). Afaik it considered best practice to commit the HTML to the project repository and the website will then be deployed to the Apache HTTP mirrors. I would prefer to commit the whole repository contents to "/website", so that everybody can easily regenerate the website. (Makefile and docs are included). Do you second this? This would mean, that "/website/htdocs" would then be mirrored to the Apache web servers (which is, without the .svn dirs, around 50MB). Kind regards, Kore -- Kore Nordmann(GPG 0xDDC70BBB) - What I do: http://kore-nordmann.de/portfolio.html - Motivate me: http://wishlist.kore-nordmann.de/ signature.asc Description: This is a digitally signed message part
