Opened 5 years ago

Closed 4 years ago

#4192 task closed fixed (fixed)

Move the content from exarkun's Twisted Web in 60 Seconds series into the Twisted Web howto

Reported by: jesstess Owned by:
Priority: normal Milestone:
Component: web Keywords: documentation
Cc: jesstess, thijs Branch: branches/web-in60-4192
(diff, github, buildbot, log)
Author: jesstess Launchpad Bug:

Description

Index for the content is here: http://jcalderone.livejournal.com/50562.html

Change History (20)

comment:1 Changed 5 years ago by jesstess

  • Author set to jesstess
  • Branch set to branches/web-in60-4192

(In [27894]) Branching to 'web-in60-4192'

comment:2 Changed 5 years ago by thijs

  • Cc thijs added
  • Keywords documentation added

Are you going to make an additional document, or cramp it all in the existing howto (which is probably already long enough)?

comment:4 Changed 5 years ago by jesstess

  • Author changed from Drivers Download to jesstess
  • Keywords review added
  • Owner jesstess deleted

Example organization of the twisted web in 60 seconds series with the first example: serving static content. The web howto has a link to the 60 seconds index which has links to all the examples, so there's minimal additional clutter on the howto index.

There are up to 17 existing examples that could go into this series. One thing that I know is missing is an attribution to exarkun.

Comments on the organization before I put in work on the rest of the examples?

comment:5 Changed 5 years ago by TimAllen

  • Owner set to TimAllen

comment:6 Changed 5 years ago by TimAllen

  • Keywords added; review removed
  • Owner changed from TimAllen to jesstess
  1. It seems to me that if exarkun's series goes on long enough, it could replace the other Web documentation, rather than accompanying it. In particular, it seems a shame to say "This set of examples is intended to be a supplement to the Using Twisted Web tutorial", when it's so much more readable than that tutorial. Maybe you could say something like "for subjects not covered here, see the Twisted Web tutorial and the API documentation".
  2. You might want to add class="python" to all the <pre/> tags that contain Python source, not just the block of code at the end.

Apart from that, looks good to me.

comment:7 Changed 5 years ago by jesstess

  • Keywords review added; removed
  • Owner jesstess deleted

TimAllen's review comments are addressed, and parts 1-6 are now in the branch. These parts are:

  • Serving static content from a directory
  • Generating a page dynamically
  • Static URL dispatch
  • Dynamic URL dispatch
  • Error handling
  • Custom response codes

A double check on the API links would be most appreciated as part of a review. After that I'll add the middle third of the examples.

comment:8 Changed 5 years ago by gas

link seemed fine to me when tested via firefox. Only issue i had was firefox didnt seem to take nay notice of the <pre class="python" tags and interpreted the html tags in the render_GET messages ie output on browser

def render_GET(self, request):

return "

%s

" % (calendar(self.year),)

I presume this is a browser xhmtl parsing failure.

Didnt see any attribution to exarkun - maybe add link to original and attribution in index?

comment:9 Changed 5 years ago by jesstess

  • Keywords review removed
  • Owner set to jesstess

comment:10 Changed 5 years ago by jesstess

  • Keywords review added
  • Owner jesstess deleted

Thanks for the review, gas!

  • gas is working out lore issues, hence the above review comment about the xhtml looking fun.
  • exarkun said he'd prefer no attribution.

Back up for review!

comment:11 Changed 5 years ago by gas

  • Keywords review removed

ok reviewed with lore all looks fine to me. maybe a suggestion for all doc should we put a last updated on them - so if newbies reading it can see if it is out of date?

comment:12 Changed 5 years ago by gas

  • Owner set to jesstess

comment:13 Changed 5 years ago by jesstess

Parts 7-12 have now been added to the branch. These parts are:

  • handling POSTs
  • rpy scripts (or, how to save yourself some typing)
  • asynchronous responses
  • asynchronous responses (via Deferred)
  • interrupted responses
  • logging errors

As before, a double check on the API links would be most appreciated as part of a review. After that I'll add the final third of the examples.

comment:14 Changed 5 years ago by jesstess

  • Keywords review added
  • Owner jesstess deleted

comment:15 Changed 5 years ago by therve

  • Keywords review removed
  • Owner set to jesstess

The reference to notifyFinish is wrong in interrupted.xhtml. Everything else looks great.

comment:15 Changed 5 years ago by jesstess

(In [28251]) Correct notifyFinish link in interrupted.xhtml

refs #4192

comment:16 Changed 4 years ago by jesstess

  • Keywords review added
  • Owner jesstess deleted

Parts 13-17 have now been added to the branch. These parts are:

  • WSGIs
  • HTTP authentication
  • Session basics
  • Storing objects in the session
  • Session endings

As before, a double check on the API links would be most appreciated as part of a review. This is the final set to review before inclusion!

comment:17 Changed 4 years ago by therve

  • Keywords review removed
  • Owner set to jesstess

Great work! Just one comment: the first Guard link in http-auth is broken.

+1!

comment:18 Changed 4 years ago by jesstess

(In [28284]) Fix guard link.

refs #4192

comment:19 Changed 4 years ago by jesstess

  • Resolution set to fixed
  • Status changed from new to closed

(In [28287]) Merge web-in60-4192

Author: jesstess
Reviewers: TimAllen, gas, therve
Fixes: #4192

Twisted Web in 60 Seconds, a series of short tutorials with
self-contained examples on a range of common web topics, is now a part
of the Twisted Web howto documentation.

comment:20 Changed 4 years ago by <automation>

  • Owner jesstess deleted
Note: See TracTickets for help on using tickets.