Put Twisted developer targetted documentation back on the website

[exarkun]

All the docs which were moved to doc/development/ no longer appear anywhere on the website. Several people have been confused/upset to discover this.

[thijs]

Is this still an issue?(!)

[exarkun]

Yes. The contents of trunk/doc/development/ still appear nowhere on the website outside of the repository browser.

[thijs]

Replying to exarkun:

Yes. The contents of trunk/doc/development/ still appear nowhere on the website outside of the repository browser.

I'm not able to fix it but raising the priority.

[thijs]

I'll add it to the wiki on TwistedDevelopment

[thijs]

See http://twistedmatrix.com/trac/wiki/TwistedDevelopment?action=diff&version=31

[glyph]

Thanks, thijs, this is definitely progress - but it's not really a complete fix.

To be complete, the generated files (i.e. the .html files produced from these .xhtml files by lore) should be on the website somewhere, ideally in the same directory structure as the "howto" documentation.

[glyph]

Whoops, added this to the description when I meant to add it in the comment:

It should probably be possible for you to fix this. It may not currently be, but can you explain why not, so you can fix other lore-documentation issues?

[thijs]

glyph, I'm not sure how and where the Apache configs are stored etc. This seems more like a task for the website maintainer that has access to the server configuration (and root access etc). Or maybe I'm missing something here?

[exarkun]

radix has the access and knowledge required.

[therve]

#3555 has been closed as a duplicate of that, talking about doc/development/legal/contributor-agreement.xhtml.

[glyph]

The reason that this documentation isn't present on the website is that the script responsible for putting stuff on the website, admin/update-documentation.py, categorizes the documentation by subproject, and 'development' is not a subproject.

This problem was caused by the solution to ticket #1617, which created this new directory. While separating out development documentation into its own category is a good idea, doing it in this particular way is problematic. This also means that the development documentation is not released as part of any dot product.

I therefore propose that we move 'development' to be a subdirectory of doc/core so that it is released with twisted core and put onto the website into the core category.

[glyph]

(In [26950]) Branching to 'devdocs-2459'

[glyph]

 build results

Moved the development directory into core and added a link to it from the core index.

[therve]

Seems correct, please merge.

[glyph]

(In [27002]) Make developer documentation subsidiary to the 'core' project, instead of off in its own weird directory.

Author: glyph

Reviewer: therve

Fixes #2459

Aside from just making the structure of the doc/ directory that much more normal, this will have two important effects:

• the developer documentation will be present in the TwistedCore 9.0 release, and
• the develpoer documentation will be accessible via the website after the 9.0 release.