Opened 10 years ago

Closed 7 years ago

#3772 enhancement closed duplicate (duplicate)

Plugin link in "writing servers" is an unwanted distraction

Reported by: mattj Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Jean-Paul Calderone, cary, Thijs Triemstra, jesstess Branch: branches/writing-server-3772-2
branch-diff, diff-cov, branch-cov, buildbot
Author: thijs


The Writing Servers page is a fairly good intro, though "you should read this document second, after first reading the top level overview of how to begin writing your Twisted application, in Writing Plug-Ins for Twisted" doesn't seem to be very good advice.

Someone reading the Writing Servers doc probably just wants to figure how a basic server works, so it would be better if the docs about plugins etc (which don't have much preface either) were left until later.

Change History (12)

comment:1 Changed 10 years ago by Jean-Paul Calderone

Cc: Jean-Paul Calderone cary Thijs Triemstra added
Component: websitecore
Keywords: documentation added
Owner: changed from oubiwann to Glyph
Priority: lownormal

The plugin document used to explain things other than how to write plugins. It got updated to document the new plugin system, though, and all of the stuff about how to structure a Twisted application was removed. I think it would be appropriate for the server howto to link to either application.xhtml or tap.xhtml or both now.

comment:2 Changed 10 years ago by Thijs Triemstra

Owner: changed from Glyph to Thijs Triemstra
Status: newassigned

comment:3 Changed 9 years ago by Thijs Triemstra

Author: thijs
Branch: branches/writing-servers-3772

(In [27111]) Branching to 'writing-servers-3772'

comment:4 Changed 9 years ago by Thijs Triemstra

Branch: branches/writing-servers-3772branches/writing-server-3772-2

(In [27995]) Branching to 'writing-server-3772-2'

comment:5 Changed 9 years ago by Thijs Triemstra

(In [27997]) Add link to tap.xhtml, refs #3772

comment:6 Changed 9 years ago by Thijs Triemstra

Keywords: review added
Owner: Thijs Triemstra deleted
Status: assignednew

comment:7 Changed 9 years ago by jesstess

Cc: jesstess added
Owner: set to jesstess

comment:8 Changed 9 years ago by jesstess

Keywords: review removed
Owner: changed from jesstess to Thijs Triemstra

Are there really people who fit the tap.xhtml target audience of "those that have developed a Twisted application which needs a command line-based deployment mechanism." who haven't already read the server howto? I think the server howto should be the first thing you read no matter what if you're new to Twisted, in which case the line in servers.xhtml containing the link in question should just go away, in my mind.

Other than that, there are 2 spots of hidden whitespace in server.xhtml that could go away.

Thanks for all the activity on documentation tickets!

comment:9 Changed 9 years ago by Thijs Triemstra

Status: newassigned

Thanks jesstess.

comment:10 Changed 8 years ago by Tom Davis

Any movement or next steps to be completed here?

comment:11 Changed 8 years ago by <automation>

Owner: Thijs Triemstra deleted

comment:12 in reply to:  10 Changed 7 years ago by Thijs Triemstra

Resolution: duplicate
Status: assignedclosed

Replying to binjured:

Any movement or next steps to be completed here?

This was fixed with #4761 so I'm marking this as a duplicate.

Note: See TracTickets for help on using tickets.