Re: [Zope-dev] zope3docs -> zopeframework
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Mar 5, 2009, at 19:08 , Martijn Faassen wrote: > Hey, > > Jens Vagelpohl wrote: >> On Mar 5, 2009, at 17:55 , Martijn Faassen wrote: >> >>> Jens, could you pick up zopeframework/trunk now for >>> http://docs.zope.org/zopeframework? And put a redirect in place for >>> http://docs.zope.org/zope3docs to the new location? >>> >>> We can then retire zope3docs. >> >> All done. > > Great, thanks Jens! > > I've just completed adding some bits and pieces to this documentation > from the document I previously posted. How often does this get > regenerated? Anyway, I expect the SVN changes will show up by > tomorrow. :) I just did a manual regeneration. The automatic build happens once a day around 7AM Eastern time. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmwHDEACgkQRAx5nvEhZLK4cgCfXwOIJk2u1tIeXinSAX3SDoMO mEQAmwWpbbUcMPUffU+RmRuC+6SrAeMo =UA/e -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework
Jens Vagelpohl wrote: > -BEGIN PGP SIGNED MESSAGE- > Hash: SHA1 > > > On Mar 5, 2009, at 17:55 , Martijn Faassen wrote: > >> Jens, could you pick up zopeframework/trunk now for >> http://docs.zope.org/zopeframework? And put a redirect in place for >> http://docs.zope.org/zope3docs to the new location? >> >> We can then retire zope3docs. > > All done. I've just retired zope3docs and left a README.txt in place to avoid confusion. Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework
Hey, Jens Vagelpohl wrote: > On Mar 5, 2009, at 17:55 , Martijn Faassen wrote: > >> Jens, could you pick up zopeframework/trunk now for >> http://docs.zope.org/zopeframework? And put a redirect in place for >> http://docs.zope.org/zope3docs to the new location? >> >> We can then retire zope3docs. > > All done. Great, thanks Jens! I've just completed adding some bits and pieces to this documentation from the document I previously posted. How often does this get regenerated? Anyway, I expect the SVN changes will show up by tomorrow. :) Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Mar 5, 2009, at 17:55 , Martijn Faassen wrote: > Jens, could you pick up zopeframework/trunk now for > http://docs.zope.org/zopeframework? And put a redirect in place for > http://docs.zope.org/zope3docs to the new location? > > We can then retire zope3docs. All done. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmwDacACgkQRAx5nvEhZLLqUACcCkhlCDTlnMNufD3wbKoRH+TU nW8AniiZCJUhQJC6DI+d9Bxwu/h7jHE1 =j7VO -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Mar 5, 2009, at 18:24 , Jens Vagelpohl wrote: > Let's do this: > > - svn copy zope3docs to zopeframework > > - once you think zopeframework is ready for public viewing, let me > know and I'll set up a self-updating sandbox and a redirect > > - after all that you can safely delete zope3docs in SVN. Just saw your other message, I'll set everything up and answer the other thread then. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmwC3sACgkQRAx5nvEhZLKVqwCeIRgkDTOTAKJVbNTuA/25e9gx pnUAn3WMB/jp0pa06UqwYfAHwxZxznKs =mzhb -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Mar 5, 2009, at 16:32 , Martijn Faassen wrote: > Thanks for pointing that out. If we moved it could you put a > redirect in > place that just pointed .../zope3docs to .../zopeframework? > > I think to get started on the move we could copy the information using > svn copy instead of svn move it, so that we don't break the URL until > we're ready updating the texts. Let's do this: - svn copy zope3docs to zopeframework - once you think zopeframework is ready for public viewing, let me know and I'll set up a self-updating sandbox and a redirect - after all that you can safely delete zope3docs in SVN. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmwCswACgkQRAx5nvEhZLIw7wCfYdIyMeo1Bdr0Z96oxzKutrh8 DM0An0bVZyVT0T7C7aXwcD71AQOx0/kv =1wTg -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
[Zope-dev] zope3docs -> zopeframework
Hi there, I've moved over the documentation zope3docs over into the zopeframework/trunk package. I left the documentation in zope3docs too for now so as not to break the automated web build system. Jens, could you pick up zopeframework/trunk now for http://docs.zope.org/zopeframework? And put a redirect in place for http://docs.zope.org/zope3docs to the new location? We can then retire zope3docs. Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
Jens Vagelpohl wrote: > -BEGIN PGP SIGNED MESSAGE- > Hash: SHA1 > > > On Mar 5, 2009, at 08:24 , Christian Theune wrote: > >> As Dan pointed out, some of those documents are a bit more general >> than >> Zope Framework, but, then again, they're also more general than Zope >> 3. >> So even for that its better to have them in the Zope Framework area >> than >> Zope 3. > > Before anything is moved around please be aware that the zope3docs > repository folder is used to rebuild http://docs.zope.org/zope3docs/ > on a daily basis. So make sure you don't completely break it since the > URL is now known, indexed and used. Thanks for pointing that out. If we moved it could you put a redirect in place that just pointed .../zope3docs to .../zopeframework? I think to get started on the move we could copy the information using svn copy instead of svn move it, so that we don't break the URL until we're ready updating the texts. Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Mar 5, 2009, at 08:24 , Christian Theune wrote: > As Dan pointed out, some of those documents are a bit more general > than > Zope Framework, but, then again, they're also more general than Zope > 3. > So even for that its better to have them in the Zope Framework area > than > Zope 3. Before anything is moved around please be aware that the zope3docs repository folder is used to rebuild http://docs.zope.org/zope3docs/ on a daily basis. So make sure you don't completely break it since the URL is now known, indexed and used. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmvg4wACgkQRAx5nvEhZLK0sgCeKvPJRd6OSzBpGY7SV1470yFq cF8AnR1ZFLTQdMdJpB36RJK+qgcL5hMG =dDsp -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
On Wed, 2009-03-04 at 20:50 +0100, Martijn Faassen wrote: > Hi there, > > On Wed, Mar 4, 2009 at 8:05 PM, Dan Korostelev wrote: > [snip > > Well, that docs are currently not necessarily about the "zope > > framework" (as far as I understood what's "zope framework" now), but > > more about general development guidelines applied to any package in > > zope svn (except the "migration" section, maybe), but I personally > > don't have any objections, as it's still easy to find those docs and > > that's the most important. :-) > > I think following the Zope Framework model we should make these > documents just apply to the source files in the Zope Framework, and > let them serve as an example for other files. There's nobody who can > *enforce* compliance though. Besides, lots of those guidelines won't > apply to Zope 2 code anyway as far as I know. > > Well, there is a group that could force compliance for the entire > repository, and that's the Zope Foundation (soon), but they care only > about a few basic things. When I started putting in those documents I named it zope3docs initially although I suspected that they would apply to what now became the Zope Framework. The migration document would ne a slight revamp though, as we don't have Zope Framework releases, yet. As Dan pointed out, some of those documents are a bit more general than Zope Framework, but, then again, they're also more general than Zope 3. So even for that its better to have them in the Zope Framework area than Zope 3. Christian -- Christian Theune · c...@gocept.com gocept gmbh & co. kg · forsterstraße 29 · 06112 halle (saale) · germany http://gocept.com · tel +49 345 1229889 7 · fax +49 345 1229889 1 Zope and Plone consulting and development signature.asc Description: This is a digitally signed message part ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
Hi there, On Wed, Mar 4, 2009 at 8:05 PM, Dan Korostelev wrote: [snip > Well, that docs are currently not necessarily about the "zope > framework" (as far as I understood what's "zope framework" now), but > more about general development guidelines applied to any package in > zope svn (except the "migration" section, maybe), but I personally > don't have any objections, as it's still easy to find those docs and > that's the most important. :-) I think following the Zope Framework model we should make these documents just apply to the source files in the Zope Framework, and let them serve as an example for other files. There's nobody who can *enforce* compliance though. Besides, lots of those guidelines won't apply to Zope 2 code anyway as far as I know. Well, there is a group that could force compliance for the entire repository, and that's the Zope Foundation (soon), but they care only about a few basic things. Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] zope3docs -> zopeframework?
2009/3/4 Martijn Faassen : > Hi there, > > We have an area called 'zope3docs': > > http://svn.zope.org/zope3docs/ > > which contains many documents that are actually more about the Zope > Framework than the Zope 3 app server. In fact I suspect all of these > documents are more about the framework than anything else, so we should > move them all over. > > http://svn.zope.org/zopeframework/trunk/ > > Opinions? Well, that docs are currently not necessarily about the "zope framework" (as far as I understood what's "zope framework" now), but more about general development guidelines applied to any package in zope svn (except the "migration" section, maybe), but I personally don't have any objections, as it's still easy to find those docs and that's the most important. :-) -- WBR, Dan Korostelev ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
[Zope-dev] zope3docs -> zopeframework?
Hi there, We have an area called 'zope3docs': http://svn.zope.org/zope3docs/ which contains many documents that are actually more about the Zope Framework than the Zope 3 app server. In fact I suspect all of these documents are more about the framework than anything else, so we should move them all over. http://svn.zope.org/zopeframework/trunk/ Opinions? Regards, Martijn ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
Christian Theune a écrit : > On Mon, 2 Feb 2009 09:16:38 -0800 > Paul Carduner wrote: > >> On Mon, Feb 2, 2009 at 8:49 AM, Christian Theune >> wrote: >>> My short-term goal is to produce a document that I can pass to new >>> developers with reasonable confidence that they know roughly how to >>> move in our community. >>> >>> In the long term I'd also like to incorporate documentation about >>> Zope 3 components themselve there. >> Awesome! >> >>> I'd be happy to get feedback on this and I'll probably come up with >>> some questions if I can't find an answer in the existing documents. >> I'll ask the question of why not put this on the new.zope.org website? > > .oO(Geez, we're bad at communicating internally ...) > > new.zope.org does not exist anymore. The project was cancelled a while > ago. We can not use that layout. there is not much design apart from the css, and a few illustrations. I've contributed some textual contents on this site, the folder arrangement, the get-started page, a few tutorials in the Example folder. You can retrieve everything and move it to the svn as rst files. I think we can keep the same kind of folder layout (Get Started, Projects with z2, z3 app, z3 library, zodb, etc.). Since the new site is not intended to be a collaborative space, we really don't need a Plone for that. A Sphinx is ideal. Christophe > > .oO(Hopefully the communication about this that ended up in my brain > was correct) > > Nevertheless, you're right about the ease of writing ReST in my own > editor. > > Christian > ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
On Mon, 02 Feb 2009 09:16:38 -0800, Paul Carduner wrote: > it would be nice if these docs could somehow magically appear on the > plone site (I'm told plone has some product for syncing content from > subversion?). http://dev.plone.org/collective/browser/FSReST ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Feb 2, 2009, at 18:32 , Christian Theune wrote: > Nevertheless, you're right about the ease of writing ReST in my own > editor. What's even better: SVN-based documentation (or buildouts that create it) can be automated so that the site can be refreshed without human intervention. FYI: A while ago I created the http://docs.zope.org/ as a possible central address for collecting generated Zope documentation. jens -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.8 (Darwin) iEYEARECAAYFAkmHMvUACgkQRAx5nvEhZLIBsACePznehn/NTrIhuQb6lEd2c+my geoAnRr5Q5qhcJymcGippg5cYjJmtAXR =iT5g -END PGP SIGNATURE- ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
On Mon, 2 Feb 2009 09:16:38 -0800 Paul Carduner wrote: > On Mon, Feb 2, 2009 at 8:49 AM, Christian Theune > wrote: > > My short-term goal is to produce a document that I can pass to new > > developers with reasonable confidence that they know roughly how to > > move in our community. > > > > In the long term I'd also like to incorporate documentation about > > Zope 3 components themselve there. > > Awesome! > > > I'd be happy to get feedback on this and I'll probably come up with > > some questions if I can't find an answer in the existing documents. > > I'll ask the question of why not put this on the new.zope.org website? .oO(Geez, we're bad at communicating internally ...) new.zope.org does not exist anymore. The project was cancelled a while ago. We can not use that layout. .oO(Hopefully the communication about this that ended up in my brain was correct) Nevertheless, you're right about the ease of writing ReST in my own editor. Christian -- Christian Theune · c...@gocept.com gocept gmbh & co. kg · forsterstraße 29 · 06112 halle (saale) · germany http://gocept.com · tel +49 345 1229889 0 · fax +49 345 1229889 1 Zope and Plone consulting and development ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
On Mon, Feb 2, 2009 at 8:49 AM, Christian Theune wrote: > My short-term goal is to produce a document that I can pass to new > developers with reasonable confidence that they know roughly how to > move in our community. > > In the long term I'd also like to incorporate documentation about Zope > 3 components themselve there. Awesome! > I'd be happy to get feedback on this and I'll probably come up with > some questions if I can't find an answer in the existing documents. I'll ask the question of why not put this on the new.zope.org website? I think the obvious response is that it's easier to write docs in rst format and stick it in subversion than to write it out on the plone site where people don't get change notifications, etc. That said, it would be nice if these docs could somehow magically appear on the plone site (I'm told plone has some product for syncing content from subversion?). Alternatively, we could just generate the docs from the rst files but use the sphinx template I made in z3c.recipe.sphinxdoc that looks just like the plone site. Hopefully there is something I can contribute to these docs, but it looks like you've got a pretty good start on them. -- Paul Carduner http://www.carduner.net ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
Re: [Zope-dev] "zope3docs"
On Mon, Feb 2, 2009 at 11:49 AM, Christian Theune wrote: > I've created a project in SVN labelled "zope3docs" and thought I'd let > you know what I intend to start doing there. > My short-term goal is to produce a document that I can pass to new > developers with reasonable confidence that they know roughly how to > move in our community. A hearty +1 from me. I have very little time to spend, but I'm sure I'll at least read what you produce in hopes of helping how I can. -- Benji York Senior Software Engineer Zope Corporation ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
[Zope-dev] "zope3docs"
Hi, I've created a project in SVN labelled "zope3docs" and thought I'd let you know what I intend to start doing there. On the sprint last week we came to the conclusion that the current state how Zope 3 and its development process are documented is inadequate: documentation is scattered over many places, none of which can be referred to as "canonical" or "official" as they are (or at least seem) mostly outdated. I started to gather the existing material on how our development process works (including my memory) and try to combine it into a coherent whole without having the distractions of the cruft in the various old places. I also try hard to stay out of the tool business. ;) My short-term goal is to produce a document that I can pass to new developers with reasonable confidence that they know roughly how to move in our community. In the long term I'd also like to incorporate documentation about Zope 3 components themselve there. I'd be happy to get feedback on this and I'll probably come up with some questions if I can't find an answer in the existing documents. Christian -- Christian Theune · c...@gocept.com gocept gmbh & co. kg · forsterstraße 29 · 06112 halle (saale) · germany http://gocept.com · tel +49 345 1229889 0 · fax +49 345 1229889 1 Zope and Plone consulting and development ___ Zope-Dev maillist - Zope-Dev@zope.org http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
