Ticket #1140 (new defect)

Opened 5 years ago

Last modified 20 months ago

Generate official documents at commit time

Reported by: hypatia Owned by: radix
Priority: high Milestone:
Component: website Keywords: documentation
Cc: radix, exarkun, spiv, hypatia, tekNico, therve, thijs Branch:
Author: Launchpad Bug:

Description


Change History

  Changed 5 years ago by hypatia

Currently, the "official" copies of the documentation are updated only at
release time. I've only heard one argument in favour of this:
 1.1 we might have development documentation that refers to things not yet released
I can think of another:
 1.2 releases usually have an associated documentation tarball which should
probably not change all the time

Here are my reasons to do this anyway:
 2.1 The vast majority of new documentation is of existing features. It is
therefore not useful to tie these to release cycles, which are about new
features and/or bugfixes
 2.2 Documentation of new features could be marked as "new in 2.2" prior to (and
after) the 2.2 release
 2.3 alternatively, documentation of new features can be developed in branchs

  Changed 5 years ago by exarkun

I don't think these things actually conflict.  We should have clearly separated
documentation sections: each release that is mentioned on the website should
have documented for *that* release available.  There should *also* be an
"in-development" documentation area that shows the very latest docs from svn.

I think we should update the coding standard to include the "new in XYZ"
suggestion, too.

  Changed 5 years ago by hypatia

exarkun's idea is good. While the usage documentation remains in active
development and behind reality (ie probably always), the latest build will be
the one that users are pointed at on the mailing lists and IRC though, so I'd
prefer that it be somewhere more official than /warner/doc-latest

  Changed 4 years ago by tekNico

  • cc tekNico added

follow-up: ↓ 6   Changed 3 years ago by therve

  • cc therve added

I closed #959 as duplicate of this one.

I think  http://twistedmatrix.com/documents/current is probably the best place for this to occur. That would be very nice to have...

in reply to: ↑ 5   Changed 20 months ago by thijs

  • cc thijs added

Replying to therve:

I think  http://twistedmatrix.com/documents/current is probably the best place for this to occur. That would be very nice to have...

+1 (and is this ticket not part of the regular-releases milestone?)

  Changed 20 months ago by exarkun

I think /documents/development might be better than /documents/current, with the former moving to the latter whenever there's a release (and the latter moving to /documents/<previous version>)

Note: See TracTickets for help on using tickets.