Python web programming infrastructure discussion

Stephan Diehl | 10 Sep 2011 11:45

Picon

www.wsgi.org to Read The Docs

Hi Graham, Christian,

the amount of SPAM is really getting insane. Earlier this year is was 
just a couple of pages once in a while. How far are we in getting things 
ready at the ReadTheDocs end? I'd say, the earlier we can switch the DNS 
entry, the better.

Cheers, Stephan

Am 29.08.2011 07:15, schrieb Christian Theune:
> On 08/29/2011 04:04 AM, Graham Dumpleton wrote:
>> Who then is the specific person who could switch the DNS for
>> www.wsgi.org to direct towards ReadTheDocs when we are ready,
>> Christian? This presumes of course people are happy about this being
>> done.
>>
>> I have been a bit busy myself, but masklinn has been doing a great job
>> at moving the pages into Sphinx format.
>>
>> We are hitting up to a dozen spam messages a day on the existing wiki
>> at the moment. 
>
> As soon as you'd like anything to change, just send me the information
> and I'll update that thing. Simplest would be to inform
> support@... (Stephan should authorize this then) so that either
> me or a colleage can pick this up.
>
> Happy to help,
> Christian
>

(Continue reading)

Masklinn | 10 Sep 2011 15:36

www.wsgi.org to Read The Docs

On 2011-09-10, at 11:45 , Stephan Diehl wrote:
> 
> How far are we in getting things ready at the ReadTheDocs end? I'd say, the earlier we can switch the DNS
entry, the better.
Everything was ported (as of August 28 anyway)[0], except for the specifications: from what I can tell,
Sphinx does not support PEP-RST[1] (it does not understand the PEP header directives, so they are not
displayed in the output), I did not get any answer when I asked about it on the pocoo IRC channel and google
searches have failed to yield any information.

Way forward I'd see would be adding a target to Sphinx's makefile to use Docutils directly to compile the
PEPs, and linking to them as if they were static HTML documents, but I do not know if RTD supports that. You'd
have to ask someone more knowledgeable (Graham has already ported the mod_wsgi docs so he might know).
From RTD's documentation, it seems accounts can be whitelisted for code execution[2], Graham probably
wouldn't have any issue getting flagged for a pair of bilding commands (and barring that, the compiled
PEPs could always be committed to the repo).

In the long run, having a pep sphinx extension might be nice.

[0] https://github.com/GrahamDumpleton/wsgiorg
[1] https://github.com/GrahamDumpleton/wsgiorg/issues/11
[2] http://read-the-docs.readthedocs.org/en/latest/faq.html
_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Graham Dumpleton | 10 Sep 2011 17:04

Picon

www.wsgi.org to Read The Docs

I'll see if I can find someone at the DjangoCon sprints who might be
able to give suggestions of what to do. The sprints are at the offices
of Eric from ReadTheDocs, so one would think I might be able to get an
answer.

On 10 September 2011 06:36, Masklinn <masklinn@...> wrote:
> On 2011-09-10, at 11:45 , Stephan Diehl wrote:
>>
>> How far are we in getting things ready at the ReadTheDocs end? I'd say, the earlier we can switch the DNS
entry, the better.
> Everything was ported (as of August 28 anyway)[0], except for the specifications: from what I can tell,
Sphinx does not support PEP-RST[1] (it does not understand the PEP header directives, so they are not
displayed in the output), I did not get any answer when I asked about it on the pocoo IRC channel and google
searches have failed to yield any information.
>
> Way forward I'd see would be adding a target to Sphinx's makefile to use Docutils directly to compile the
PEPs, and linking to them as if they were static HTML documents, but I do not know if RTD supports that. You'd
have to ask someone more knowledgeable (Graham has already ported the mod_wsgi docs so he might know).
From RTD's documentation, it seems accounts can be whitelisted for code execution[2], Graham probably
wouldn't have any issue getting flagged for a pair of bilding commands (and barring that, the compiled
PEPs could always be committed to the repo).
>
> In the long run, having a pep sphinx extension might be nice.
>
> [0] https://github.com/GrahamDumpleton/wsgiorg
> [1] https://github.com/GrahamDumpleton/wsgiorg/issues/11
> [2] http://read-the-docs.readthedocs.org/en/latest/faq.html
_______________________________________________
Web-SIG mailing list
Web-SIG@...

(Continue reading)

Stephan Diehl | 10 Sep 2011 21:18

Picon

www.wsgi.org to Read The Docs

I'm still not sure about the intended workflow:
1. wsgi.org content repository is on github which is developer friendly.
    But, who decides about write access? In pratice, this might not be
    a problem though, because it's only a handfull people anyway, who
    are actively contributing.
2. The actual pages (sphinx?) should then be hosted by ReadTheDocs?

Where does the wsgi.org domain come into play? Does ReadTheDocs provide 
virtual (apache) hosts? We can't just point wsgi.org to ReadTheDocs.org, 
right? Or should we just have a static page on wsgi.org that contains a 
link to ReadTheDocs?

Stephan

Am 10.09.2011 17:04, schrieb Graham Dumpleton:
> I'll see if I can find someone at the DjangoCon sprints who might be
> able to give suggestions of what to do. The sprints are at the offices
> of Eric from ReadTheDocs, so one would think I might be able to get an
> answer.
>
> On 10 September 2011 06:36, Masklinn<masklinn@...>  wrote:
>> On 2011-09-10, at 11:45 , Stephan Diehl wrote:
>>>
>>> How far are we in getting things ready at the ReadTheDocs end? I'd say, the earlier we can switch the DNS
entry, the better.
>> Everything was ported (as of August 28 anyway)[0], except for the specifications: from what I can tell,
Sphinx does not support PEP-RST[1] (it does not understand the PEP header directives, so they are not
displayed in the output), I did not get any answer when I asked about it on the pocoo IRC channel and google
searches have failed to yield any information.
>>

(Continue reading)

Masklinn | 10 Sep 2011 21:29

www.wsgi.org to Read The Docs

On 2011-09-10, at 21:18 , Stephan Diehl wrote:
> I'm still not sure about the intended workflow:
> 1. wsgi.org content repository is on github which is developer friendly.
>   But, who decides about write access? In pratice, this might not be
>   a problem though, because it's only a handfull people anyway, who
>   are actively contributing.
Currently, only Graham has write access (the repository is in his github account), contributors have to
fork the repository and create pull requests (this can be done entirely from github's web interface for
small fixes, for bigger contributions it requires creating an actual fork and doing work "offline" to
push later). I do not know if he expects (or can) give write access to others.

> 2. The actual pages (sphinx?) should then be hosted by ReadTheDocs?
There's the option of hosting it on a separate server as well (compile the docs and point an apache/nginx to
the _build directory), but RTD has all the architecture in place (including stuff like webhooks to ensure
it's got the latest version of the project/docs). So that's pretty convenient.

> Where does the wsgi.org domain come into play? Does ReadTheDocs provide virtual (apache) hosts?
RTD provides subdomains and you can just point your DNS CNAME to it

> We can't just point wsgi.org to ReadTheDocs.org, right?
That's exactly it actually: http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html

_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Stephan Diehl | 10 Sep 2011 21:49

Picon

www.wsgi.org to Read The Docs

Am 10.09.2011 21:29, schrieb Masklinn:
[...]
>> We can't just point wsgi.org to ReadTheDocs.org, right?
> That's exactly it actually: http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html
>

Ahh, excelent. Didn't see that.
I guess we should change the CNAME as soon as possible.

Cheers, Stephan

_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Graham Dumpleton | 10 Sep 2011 22:18

Picon

www.wsgi.org to Read The Docs

We haven't actually done a push up to ReadTheDocs yet.

Sorry, just been too busy with work and trip to US. I expect things to
calm down once get home this week.

FWIW, have no issues with adding other people to have direct commit
rights to wsgiorg project so I am not a bottleneck.

Graham

On 10 September 2011 12:49, Stephan Diehl <stephan@...> wrote:
> Am 10.09.2011 21:29, schrieb Masklinn:
> [...]
>>>
>>> We can't just point wsgi.org to ReadTheDocs.org, right?
>>
>> That's exactly it actually:
>> http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html
>>
>
> Ahh, excelent. Didn't see that.
> I guess we should change the CNAME as soon as possible.
>
> Cheers, Stephan
>
>
>
>
_______________________________________________
Web-SIG mailing list

(Continue reading)

Masklinn | 16 Sep 2011 11:46

www.wsgi.org to Read The Docs

On 2011-09-10, at 22:18 , Graham Dumpleton wrote:
> We haven't actually done a push up to ReadTheDocs yet.
> 
> Sorry, just been too busy with work and trip to US. I expect things to
> calm down once get home this week.
Apart from your chronic lack of time, is there anything left blocking
the push on RTD I can help with?
_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Graham Dumpleton | 16 Sep 2011 12:20

Picon

www.wsgi.org to Read The Docs

On 16 September 2011 19:46, Masklinn <masklinn@...> wrote:
> On 2011-09-10, at 22:18 , Graham Dumpleton wrote:
>> We haven't actually done a push up to ReadTheDocs yet.
>>
>> Sorry, just been too busy with work and trip to US. I expect things to
>> calm down once get home this week.
> Apart from your chronic lack of time, is there anything left blocking
> the push on RTD I can help with?

http://wsgiorg.rtfd.org/

Someone needs to work on the template to replace generic Sphinx type
header/footers with more appropriate branding. Having it say version
X.Y of documentation, trying to attribute copyright to specific person
etc don't make sense.

Graham
_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Masklinn | 16 Sep 2011 19:05

www.wsgi.org to Read The Docs

On 2011-09-16, at 12:20 , Graham Dumpleton wrote:
> On 16 September 2011 19:46, Masklinn <masklinn@...> wrote:
>> On 2011-09-10, at 22:18 , Graham Dumpleton wrote:
>>> We haven't actually done a push up to ReadTheDocs yet.
>>> 
>>> Sorry, just been too busy with work and trip to US. I expect things to
>>> calm down once get home this week.
>> Apart from your chronic lack of time, is there anything left blocking
>> the push on RTD I can help with?
> 
> http://wsgiorg.rtfd.org/
> 
Cool. So Christian just needs to update the DNS records now?

> Someone needs to work on the template to replace generic Sphinx type
> header/footers with more appropriate branding. Having it say version
> X.Y of documentation, trying to attribute copyright to specific person
> etc don't make sense.
I'll see if I can find how to do that this week-end.
_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig
Unsubscribe: http://mail.python.org/mailman/options/web-sig/gcpw-web-sig%40m.gmane.org

Randy Syring | 16 Sep 2011 19:16

Picon

www.wsgi.org to Read The Docs

> http://wsgiorg.rtfd.org/

Thanks guys for putting in the time to convert the site over.

--------------------------------------
Randy Syring
Intelicom
Direct: 502-276-0459
Office: 502-212-9913

For the wages of sin is death, but the
free gift of God is eternal life in
Christ Jesus our Lord (Rom 6:23)

On 09/16/2011 01:05 PM, Masklinn wrote:
> On 2011-09-16, at 12:20 , Graham Dumpleton wrote:
>> On 16 September 2011 19:46, Masklinn<masklinn@...>  wrote:
>>> On 2011-09-10, at 22:18 , Graham Dumpleton wrote:
>>>> We haven't actually done a push up to ReadTheDocs yet.
>>>>
>>>> Sorry, just been too busy with work and trip to US. I expect things to
>>>> calm down once get home this week.
>>> Apart from your chronic lack of time, is there anything left blocking
>>> the push on RTD I can help with?
>> http://wsgiorg.rtfd.org/
>>
> Cool. So Christian just needs to update the DNS records now?
>
>> Someone needs to work on the template to replace generic Sphinx type
>> header/footers with more appropriate branding. Having it say version

(Continue reading)

Graham Dumpleton | 16 Sep 2011 23:10

Picon

www.wsgi.org to Read The Docs

On 17 September 2011 03:05, Masklinn <masklinn@...> wrote:
> On 2011-09-16, at 12:20 , Graham Dumpleton wrote:
>> On 16 September 2011 19:46, Masklinn <masklinn@...> wrote:
>>> On 2011-09-10, at 22:18 , Graham Dumpleton wrote:
>>>> We haven't actually done a push up to ReadTheDocs yet.
>>>>
>>>> Sorry, just been too busy with work and trip to US. I expect things to
>>>> calm down once get home this week.
>>> Apart from your chronic lack of time, is there anything left blocking
>>> the push on RTD I can help with?
>>
>> http://wsgiorg.rtfd.org/
>>
> Cool. So Christian just needs to update the DNS records now?

Don't see any reason why not. Is looking clean and slick now.

I have added you as collaborator to wsgiorg project out of guthub. I
presume that means you can push changes back in somehow without
waiting on me now. Never had to do that. If anyone else wants to step
up to be maintainer on site can add them as well.

I'll also try and setup the hooks so updates automatically get applied
to ReadTheDocs.

Graham
_______________________________________________
Web-SIG mailing list
Web-SIG@...
Web SIG: http://www.python.org/sigs/web-sig

(Continue reading)

Graham Dumpleton | 11 Sep 2011 00:30

Picon

www.wsgi.org to Read The Docs

Just change:

:Title: Waiting for File Descriptor Events
:Author: Christopher Stawarz <chris@...>
:Discussions-To: Python Web-SIG <web-sig@...>
:Status: Proposed
:Created: 11-May-2008

to:

Waiting for File Descriptor Events
========================

:Author: Christopher Stawarz <chris@...>
:Discussions-To: Python Web-SIG <web-sig@...>
:Status: Proposed
:Created: 11-May-2008

and it should be fine,

The table of information is only special if at the very start of the
document. So, move title out of the table and put it first as normal
title with underlining of some description so know it is title.

Graham

On 10 September 2011 06:36, Masklinn <masklinn@...> wrote:
> On 2011-09-10, at 11:45 , Stephan Diehl wrote:
>>
>> How far are we in getting things ready at the ReadTheDocs end? I'd say, the earlier we can switch the DNS

(Continue reading)

Masklinn | 11 Sep 2011 11:24

www.wsgi.org to Read The Docs

On 2011-09-11, at 00:30 , Graham Dumpleton wrote:
> Just change:
> 
> :Title: Waiting for File Descriptor Events
> :Author: Christopher Stawarz <chris@...>
> :Discussions-To: Python Web-SIG <web-sig@...>
> :Status: Proposed
> :Created: 11-May-2008
> 
> to:
> 
> Waiting for File Descriptor Events
> ========================
> 
> :Author: Christopher Stawarz <chris@...>
> :Discussions-To: Python Web-SIG <web-sig@...>
> :Status: Proposed
> :Created: 11-May-2008
> 
> and it should be fine,
> 
> The table of information is only special if at the very start of the
> document. So, move title out of the table and put it first as normal
> title with underlining of some description so know it is title.
Interesting that this should be special-cased so, but it seems to
work very well indeed with those modifications. With that, I'll try
to have the specifications subtree converted by day's end, there
should be no hangup left on .
_______________________________________________
Web-SIG mailing list

(Continue reading)

Return

Return to gmane.comp.python.web.

Advertisement

Project Web Page

Python web programming infrastructure discussion

Search Archive

Language

Change language

Options

Current view: Threads only / Showing only 20 lines / Not hiding cited text.
Change to All messages, whole messages, or hide cited text.

Post a message
NNTP Newsgroup
Classic Gmane web interface
XML

XML

RSS Feed
List Information

About Gmane