Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#4575 enhancement closed fixed (fixed)

Improve lore2sphinx buildbot results for `projects/vfs`

Reported by: khorn Owned by:
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords:
Cc: Branch: branches/improve-lore2sphinx-output-for-projects-vfs-4575
branch-diff, diff-cov, branch-cov, buildbot
Author: khorn


like #4566, except for projects/vfs

Change History (8)

comment:1 Changed 11 years ago by Glyph

Summary: Improve lore2sphinx buildbot results for `projects/conch`Improve lore2sphinx buildbot results for `projects/vfs`

comment:2 Changed 11 years ago by khorn

Owner: changed from Glyph to khorn

comment:3 Changed 11 years ago by khorn

Author: khorn
Branch: branches/improve-lore2sphinx-output-for-projects-vfs-4575

(In [29882]) Branching to 'improve-lore2sphinx-output-for-projects-vfs-4575'

comment:4 Changed 11 years ago by khorn

Keywords: review added
Owner: khorn deleted

There's almost nothing to do here as far as existing markup, however, the links in examples/index.xhtml don't actually go anywhere. Since the examples are all made up of multiple files, it doesn't make sense to point to any single file, but there's no existing documentation that ties the various files for the examples together.

So, do we do nothing and add this "chunk" as is? Or do we add an index file in Lore format to the existing examples/vfsapp and examples/welsh directories?

And if we do want to add those Lore index files, should they be added under this ticket, or another one?

[sending this to review in the hopes that someone will comment...even though nothing has actually been done yet]

comment:5 Changed 11 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to khorn

One thing to note is that we don't publish the vfs docs on the website. So no matter what we do, there's no regression. Another thing to note is that vfs seems largely abandoned, and at least a few long-time Twisted developers don't agree that vfs is the right direction to be taking development in order to accomplish the goals it sets out to accomplish. So writing new documentation for it seems like a poor use of time. Perhaps the important thing to address is to be sure the vfs docs aren't published after the sphinx conversion, either (likewise for web2).

comment:6 Changed 11 years ago by khorn

Resolution: fixed
Status: newclosed

In that case, I guess we'll consider this one to be fixed

If anyone seriously disagrees, either reopen or file a new ticket.

comment:7 Changed 11 years ago by khorn

Milestone: Lore to Sphinx

comment:8 Changed 11 years ago by <automation>

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